Function CMS_Topic->render_as_comment_topic
Definitions
sources/topics.php
- Render a comment topic.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $content_type | ID_TEXT | required parameter | N/A | N/A | Content type to show topic for |
| $content_id | ID_TEXT | required parameter | N/A | N/A | Content ID of content type to show topic for |
| $invisible_if_no_comments | boolean | required parameter | N/A | N/A | Whether the comment box will be invisible if there are not yet any comments (and you're not staff) |
| $forum_name | ?string | required parameter | N/A | N/A | The name of the forum to use (null: default comment forum) |
| $post_warning | ?string | required parameter | N/A | N/A | The default post to use (null: standard courtesy warning) |
| $preloaded_comments | ?mixed | required parameter | N/A | N/A | The raw comment array (null: lookup). This is useful if we want to pass it through a filter |
| $reverse | ?boolean | required parameter | N/A | N/A | Whether to show in reverse date order (affects default search order only) (null: read config) |
| $highlight_by_member | ?MEMBER | required parameter | N/A | N/A | Member to highlight the posts of (null: none) |
| $allow_reviews | boolean | required parameter | N/A | N/A | Whether to allow ratings along with the comment (like reviews) |
| $num_to_show_limit | ?integer | required parameter | N/A | N/A | Maximum to load (null: default) |
| $hidden | ?Tempcode | Null | N/A | N/A | Hidden form fields for commenting form (null: none) |
Return
- The Tempcode for the comment topic
- Type: Tempcode
- Set: N/A
- Range: N/A