Function __global->_build_sitemap_menu

Definitions

sources/menus.php

  • Take a menu identifier, and return a Sitemap-based menu created from it.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$menu_id SHORT_TEXT No No required parameter N/A N/A The menu identifier to use (syntax to load from the Sitemap)
$tray_status string No No tray_closed tray_open tray_closed N/A The default expansion status of the node

Returns

  • The Sitemap node structure (called a 'branch structure' for menus)
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Take a menu identifier, and return a Sitemap-based menu created from it.
 *
 * @param  SHORT_TEXT $menu_id The menu identifier to use (syntax to load from the Sitemap)
 * @param  string $tray_status The default expansion status of the node
 * @set tray_open tray_closed
 * @return array The Sitemap node structure (called a 'branch structure' for menus)
 */
function _build_sitemap_menu(string $menu_id, string $tray_status = 'tray_closed') : array