Function __global->cns_get_all_subordinate_forums

Definitions

sources/cns_forums.php

  • Gets a list of subordinate forums of a certain forum.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$forum_id ?AUTO_LINK No No required parameter N/A N/A The ID of the forum we are finding subordinate forums of (null: private topic)
$create_or_list ?string No No Null N/A N/A The field name to use in the OR list (null: do not make an OR list, return an array)
$tree ?array No No Null N/A N/A The forum tree structure (null: unknown, it will be found using cns_organise_into_tree)
$ignore_permissions boolean No No False N/A N/A Whether to ignore permissions in this

Returns

  • The list (is either a true list, or an OR list)
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Gets a list of subordinate forums of a certain forum.
 *
 * @param  ?AUTO_LINK $forum_id The ID of the forum we are finding subordinate forums of (null: private topic)
 * @param  ?string $create_or_list The field name to use in the OR list (null: do not make an OR list, return an array)
 * @param  ?array $tree The forum tree structure (null: unknown, it will be found using cns_organise_into_tree)
 * @param  boolean $ignore_permissions Whether to ignore permissions in this
 * @return mixed The list (is either a true list, or an OR list)
 */
function cns_get_all_subordinate_forums(?int $forum_id, ?string $create_or_list = null, ?array $tree = null, bool $ignore_permissions = false)