Function CMS_Topic->load_from_topic
Definitions
sources/topics.php
- Load from a given topic ID.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: bool
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $topic_id | ?AUTO_LINK | required parameter | N/A | N/A | Topic ID (null: none yet, set up empty structure) |
| $num_to_show_limit | integer | required parameter | N/A | N/A | Maximum to load |
| $start | integer | 0 | N/A | N/A | Pagination start if non-threaded |
| $reverse | ?boolean | Null | N/A | N/A | Whether to show in reverse date order (affects default search order only) (null: read config) |
| $posts | ?array | Null | N/A | N/A | List of post IDs to load (null: no filter) |
| $load_spacer_posts_too | boolean | False | N/A | N/A | Whether to allow spacer posts to flow through the renderer |
Return
- Success status
- Type: boolean
- Set: N/A
- Range: N/A