Function Module_topics->cns_ping_topic_unread
Definitions
forum/pages/modules/topics.php
- Mark a topic as unread by the current member.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $topic_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the topic to mark as unread |
Returns
- Success status (false = too old to mark read; true = marked read or topic entirely missing)
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Mark a topic as unread by the current member.
*
* @param AUTO_LINK $topic_id The ID of the topic to mark as unread
* @return boolean Success status (false = too old to mark read; true = marked read or topic entirely missing)
*/
public function cns_ping_topic_unread(int $topic_id) : bool
* Mark a topic as unread by the current member.
*
* @param AUTO_LINK $topic_id The ID of the topic to mark as unread
* @return boolean Success status (false = too old to mark read; true = marked read or topic entirely missing)
*/
public function cns_ping_topic_unread(int $topic_id) : bool
