Function __global->cns_forum_breadcrumbs

Definitions

sources/cns_forums.php

  • Get breadcrumbs for a forum.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$end_point_forum ?~mixed No No required parameter N/A N/A The ID of the forum we are at in our path (null: end of recursion) (false: no forum ID available, this_name and parent_forum must not be null)
$this_name ?mixed No No Null N/A N/A The name of the given forum as string or Tempcode (null: find it from the DB)
$parent_forum ?AUTO_LINK No No Null N/A N/A The parent forum of the given forum (null: find it from the DB)
$start boolean No No True N/A N/A Whether this is being called as the recursion start of deriving the breadcrumbs (top level call)
$root ?AUTO_LINK No No Null N/A N/A Virtual root (null: none)

Returns

  • The breadcrumbs
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get breadcrumbs for a forum.
 *
 * @param  ?~mixed $end_point_forum The ID of the forum we are at in our path (null: end of recursion) (false: no forum ID available, this_name and parent_forum must not be null)
 * @param  ?mixed $this_name The name of the given forum as string or Tempcode (null: find it from the DB)
 * @param  ?AUTO_LINK $parent_forum The parent forum of the given forum (null: find it from the DB)
 * @param  boolean $start Whether this is being called as the recursion start of deriving the breadcrumbs (top level call)
 * @param  ?AUTO_LINK $root Virtual root (null: none)
 * @return array The breadcrumbs
 */
function cns_forum_breadcrumbs($end_point_forum, $this_name = null, ?int $parent_forum = null, bool $start = true, ?int $root = null) : array