Function __global->is_ticket_forum

Definitions

sources/tickets.php

  • Returns whether the given forum ID is for a ticket forum (subforum of the root ticket forum).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$forum_id ?AUTO_LINK No No required parameter N/A N/A The forum ID (null: private topics)

Returns

  • Whether the given forum is a ticket forum
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Returns whether the given forum ID is for a ticket forum (subforum of the root ticket forum).
 *
 * @param  ?AUTO_LINK $forum_id The forum ID (null: private topics)
 * @return boolean Whether the given forum is a ticket forum
 */
function is_ticket_forum(?int $forum_id) : bool