Function Forum_driver_cns->topic_url

Definitions

sources/forum/cns.php

  • Get a URL to the specified topic ID. Most forums don't require the second parameter, but some do, so it is required in the interface.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$topic_id integer No No required parameter N/A N/A The topic ID
$forum string No No Blank (empty string) N/A N/A The forum ID
$tempcode_okay boolean No No False N/A N/A Whether it is okay to return the result using Tempcode (more efficient)

Returns

  • The URL to the topic
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a URL to the specified topic ID. Most forums don't require the second parameter, but some do, so it is required in the interface.
 *
 * @param  integer $topic_id The topic ID
 * @param  string $forum The forum ID
 * @param  boolean $tempcode_okay Whether it is okay to return the result using Tempcode (more efficient)
 * @return mixed The URL to the topic
 */
public function topic_url(int $topic_id, string $forum = '', bool $tempcode_okay = false)