Function Forum_driver_none->pin_topic

Definitions

sources/forum/none.php

  • Pin a topic.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$topic_id AUTO_LINK No No required parameter N/A N/A The topic ID
$pin boolean No No True N/A N/A True: pin it, False: unpin it

Preview

Code (PHP)

/**
 * Pin a topic.
 *
 * @param  AUTO_LINK $topic_id The topic ID
 * @param  boolean $pin True: pin it, False: unpin it
 */
public function pin_topic(int $topic_id, bool $pin = true)