Function __global->gallery_breadcrumbs

Definitions

sources/galleries.php

  • Get a route from a known gallery 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
$gallery ID_TEXT No No required parameter N/A N/A The gallery name
$root ?ID_TEXT No No root N/A N/A The virtual root (null: none)
$include_link boolean No No False N/A N/A Whether to put a link at this point in the breadcrumbs (usually, because the viewer is already at it)
$zone ID_TEXT No No Blank (empty string) N/A N/A The zone that the linked to gallery module is in
$attach_to_url_filter boolean No No False N/A N/A Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing

Returns

  • The navigation element
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a route from a known gallery back to the declared root of the tree.
 *
 * @param  ID_TEXT $gallery The gallery name
 * @param  ?ID_TEXT $root The virtual root (null: none)
 * @param  boolean $include_link Whether to put a link at this point in the breadcrumbs (usually, because the viewer is already at it)
 * @param  ID_TEXT $zone The zone that the linked to gallery module is in
 * @param  boolean $attach_to_url_filter Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
 * @return array The navigation element
 */
function gallery_breadcrumbs(string $gallery, ?string $root = 'root', bool $include_link = false, string $zone = '', bool $attach_to_url_filter = false) : array