Function Module_topics->redirect_to_forum

Definitions

forum/pages/modules/topics.php

  • Do a redirection page to a certain forum (because we've just done an action and want to go back).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$_title ID_TEXT No No required parameter N/A N/A The language string codename for the title to use in the page
$forum_id ?AUTO_LINK No No required parameter N/A N/A The ID of the forum to redirect to (null: PTs)
$lang ?mixed No No Null N/A N/A What to output (string or Tempcode) (null: default)

Returns

  • The UI
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Do a redirection page to a certain forum (because we've just done an action and want to go back).
 *
 * @param  ID_TEXT $_title The language string codename for the title to use in the page
 * @param  ?AUTO_LINK $forum_id The ID of the forum to redirect to (null: PTs)
 * @param  ?mixed $lang What to output (string or Tempcode) (null: default)
 * @return Tempcode The UI
 */
public function redirect_to_forum(string $_title, ?int $forum_id, $lang = null) : object