function menu_tree_all_data

Gets the data structure representing a named menu tree.

Since this can be the full tree including hidden items, the data returned may be used for generating an an admin interface or a select.

@since 1.17.5 $langcode parameter added.

Parameters

$menu_name: The named menu links to return

$link: A fully loaded menu link, or NULL. If a link is supplied, only the path to root will be included in the returned tree - as if this link represented the current page in a visible menu.

$max_depth: Optional maximum depth of links to retrieve. Typically useful if only one or two levels of a sub tree are needed in conjunction with a non-NULL $link, in which case $max_depth should be greater than $link['depth'].

string $langcode: Optional, filter tree by this langcode, defaults to current language if not set. Language neutral items are always included.

Return value

An tree of menu links in an array, in the order they should be rendered.:

Related topics

File

core/includes/menu.inc, line 1200

API for the Backdrop menu system.

Code

function menu_tree_all_data($menu_name, $link = NULL, $max_depth = NULL, $langcode = NULL) {
  $tree = &backdrop_static(__FUNCTION__, array());

  // Use $mlid as a flag for whether the data being loaded is for the whole tree.
  $mlid = isset($link['mlid']) ? $link['mlid'] : 0;
  // Generate a cache ID (cid) specific for this $menu_name, $link, $language, and depth.
  if (empty($langcode)) {
    $langcode = $GLOBALS['language']->langcode;
    $langcode_params = FALSE;
  }
  else {
    if ($langcode == LANGUAGE_NONE) {
      // Language neutral items can be attached to any parent.
      $all_enabled = language_list(TRUE);
      $langcode_params = array_keys($all_enabled);
    }
    else {
      $langcode_params = array($langcode);
    }
    $langcode_params[] = LANGUAGE_NONE;
  }
  $cid = 'links:' . $menu_name . ':all:' . $mlid . ':' . $langcode . ':' . (int) $max_depth;

  if (!isset($tree[$cid])) {
    // If the static variable doesn't have the data, check {cache_menu}.
    $cache = cache('menu')->get($cid);
    if ($cache && isset($cache->data)) {
      // If the cache entry exists, it contains the parameters for
      // menu_build_tree().
      $tree_parameters = $cache->data;
    }
    // If the tree data was not in the cache, build $tree_parameters.
    if (!isset($tree_parameters)) {
      $tree_parameters = array(
        'min_depth' => 1,
        'max_depth' => $max_depth,
      );
      if ($mlid) {
        // The tree is for a single item, so we need to match the values in its
        // p columns and 0 (the top level) with the plid values of other links.
        $parents = array(0);
        for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
          if (!empty($link["p$i"])) {
            $parents[] = $link["p$i"];
          }
        }
        $tree_parameters['expanded'] = $parents;
        $tree_parameters['active_trail'] = $parents;
        $tree_parameters['active_trail'][] = $mlid;
      }
      if ($langcode_params) {
        $tree_parameters['langcode'] = $langcode_params;
      }

      // Cache the tree building parameters using the page-specific cid.
      cache('menu')->set($cid, $tree_parameters);
    }

    // Build the tree using the parameters; the resulting tree will be cached
    // by _menu_build_tree()).
    $tree[$cid] = menu_build_tree($menu_name, $tree_parameters);
  }

  return $tree[$cid];
}