Function __global->is_sitemap_menu

Definitions

sources/menus.php

  • Find if a menu is a Sitemap menu (as opposed to a stored menu).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$menu SHORT_TEXT No No required parameter N/A N/A The menu identifier

Returns

  • Whether it is a Sitemap menu
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find if a menu is a Sitemap menu (as opposed to a stored menu).
 *
 * @param  SHORT_TEXT $menu The menu identifier
 * @return boolean Whether it is a Sitemap menu
 */
function is_sitemap_menu(string $menu) : bool