Function __global->comcode_breadcrumbs

Definitions

sources/site.php

  • Get a route from a known Comcode page back to the declared root of the tree.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$the_page ID_TEXT No No required parameter N/A N/A The Comcode page name
$the_zone ID_TEXT No No required parameter N/A N/A The Comcode page zone
$root ID_TEXT No No Blank (empty string) N/A N/A The virtual root
$include_link boolean No No False N/A N/A Whether not to put a link at this point in the navigation tree (usually, because the viewer is already at it)
$jumps integer No No 0 N/A N/A The number of jumps we have gone through so far (cuts out after 10 as a failsafe)

Returns

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

Preview

Code (PHP)

/**
 * Get a route from a known Comcode page back to the declared root of the tree.
 *
 * @param  ID_TEXT $the_page The Comcode page name
 * @param  ID_TEXT $the_zone The Comcode page zone
 * @param  ID_TEXT $root The virtual root
 * @param  boolean $include_link Whether not to put a link at this point in the navigation tree (usually, because the viewer is already at it)
 * @param  integer $jumps The number of jumps we have gone through so far (cuts out after 10 as a failsafe)
 * @return array The breadcrumbs
 */
function comcode_breadcrumbs(string $the_page, string $the_zone, string $root = '', bool $include_link = false, int $jumps = 0) : array