Function __global->actualise_post_comment
Definitions
sources/feedback.php
- Add comments to the specified resource.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $allow_comments | boolean | No | No | required parameter | N/A | N/A | Whether this resource allows comments (if not, this function does nothing - but it's nice to move out this common logic into the shared function) |
| $feedback_type | ID_TEXT | No | No | required parameter | N/A | N/A | The feedback type (downloads, etc) that this commenting is for |
| $content_id | ID_TEXT | No | No | required parameter | N/A | N/A | The ID of the type that this commenting is for |
| $content_url | mixed | No | No | required parameter | N/A | N/A | The URL to where the commenting will pass back to (to put into the comment topic header) (URLPATH or Tempcode) |
| $content_title | ?string | No | No | required parameter | N/A | N/A | The title to where the commenting will pass back to (to put into the comment topic header) (null: don't know, but not first post so not important) |
| $forum | ?string | No | No | Null | N/A | N/A | The name of the forum to use (null: default comment forum) |
| $do_captcha | boolean | No | No | True | N/A | N/A | Whether to require a captcha |
| $validated | ?BINARY | No | No | Null | N/A | N/A | Whether the post is validated (null: unknown, find whether it needs to be marked not validated initially). This only works with the Conversr driver (hence is the last parameter). |
| $explicit_allow | boolean | No | No | False | N/A | N/A | Whether to force allowance |
| $show_success_message | boolean | No | No | True | N/A | N/A | Whether to show a success message |
| $private | boolean | No | No | False | N/A | N/A | Whether posts made should not be shared |
| $post_title | ?string | No | No | Null | N/A | N/A | Title of the post (null: lookup from POST environment) |
| $post | ?string | No | No | Null | N/A | N/A | Body of the post (null: lookup from POST environment) |
| $time | ?TIME | No | No | Null | N/A | N/A | Time of comment topic (null: now) |
Returns
- Whether a hidden post has been made
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Add comments to the specified resource.
*
* @param boolean $allow_comments Whether this resource allows comments (if not, this function does nothing - but it's nice to move out this common logic into the shared function)
* @param ID_TEXT $feedback_type The feedback type (downloads, etc) that this commenting is for
* @param ID_TEXT $content_id The ID of the type that this commenting is for
* @param mixed $content_url The URL to where the commenting will pass back to (to put into the comment topic header) (URLPATH or Tempcode)
* @param ?string $content_title The title to where the commenting will pass back to (to put into the comment topic header) (null: don't know, but not first post so not important)
* @param ?string $forum The name of the forum to use (null: default comment forum)
* @param boolean $do_captcha Whether to require a captcha
* @param ?BINARY $validated Whether the post is validated (null: unknown, find whether it needs to be marked not validated initially). This only works with the Conversr driver (hence is the last parameter).
* @param boolean $explicit_allow Whether to force allowance
* @param boolean $show_success_message Whether to show a success message
* @param boolean $private Whether posts made should not be shared
* @param ?string $post_title Title of the post (null: lookup from POST environment)
* @param ?string $post Body of the post (null: lookup from POST environment)
* @param ?TIME $time Time of comment topic (null: now)
* @return boolean Whether a hidden post has been made
*/
function actualise_post_comment(bool $allow_comments, string $feedback_type, string $content_id, $content_url, ?string $content_title, ?string $forum = null, bool $do_captcha = true, ?int $validated = null, bool $explicit_allow = false, bool $show_success_message = true, bool $private = false, ?string $post_title = null, ?string $post = null, ?int $time = null) : bool
* Add comments to the specified resource.
*
* @param boolean $allow_comments Whether this resource allows comments (if not, this function does nothing - but it's nice to move out this common logic into the shared function)
* @param ID_TEXT $feedback_type The feedback type (downloads, etc) that this commenting is for
* @param ID_TEXT $content_id The ID of the type that this commenting is for
* @param mixed $content_url The URL to where the commenting will pass back to (to put into the comment topic header) (URLPATH or Tempcode)
* @param ?string $content_title The title to where the commenting will pass back to (to put into the comment topic header) (null: don't know, but not first post so not important)
* @param ?string $forum The name of the forum to use (null: default comment forum)
* @param boolean $do_captcha Whether to require a captcha
* @param ?BINARY $validated Whether the post is validated (null: unknown, find whether it needs to be marked not validated initially). This only works with the Conversr driver (hence is the last parameter).
* @param boolean $explicit_allow Whether to force allowance
* @param boolean $show_success_message Whether to show a success message
* @param boolean $private Whether posts made should not be shared
* @param ?string $post_title Title of the post (null: lookup from POST environment)
* @param ?string $post Body of the post (null: lookup from POST environment)
* @param ?TIME $time Time of comment topic (null: now)
* @return boolean Whether a hidden post has been made
*/
function actualise_post_comment(bool $allow_comments, string $feedback_type, string $content_id, $content_url, ?string $content_title, ?string $forum = null, bool $do_captcha = true, ?int $validated = null, bool $explicit_allow = false, bool $show_success_message = true, bool $private = false, ?string $post_title = null, ?string $post = null, ?int $time = null) : bool