function menu_tree_data

Sorts and returns the built data representing a menu tree.

Parameters

$links: A flat array of menu links that are part of the menu. Each array element is an associative array of information about the menu link, containing the fields from the {menu_links} table, and optionally additional information from the {menu_router} table, if the menu item appears in both tables. This array must be ordered depth-first. See _menu_build_tree() for a sample query.

$parents: An array of the menu link ID values that are in the path from the current page to the root of the menu tree.

$depth: The minimum depth to include in the returned menu tree.

Return value

An array of menu links in the form of a tree. Each item in the tree is an associative array containing:

  • link: The menu link item from $links, with additional element 'in_active_trail' (TRUE if the link ID was in $parents).
  • below: An array containing the sub-tree of this item, where each element is a tree item array with 'link' and 'below' elements. This array will be empty if the menu item has no items in its sub-tree having a depth greater than or equal to $depth.

Related topics

Menu system
Define the navigation menus, and route page requests to code based on URLs.
5 calls to menu_tree_data()
book_menu_subtree_data in drupal/core/modules/book/book.module
Gets the data representing a subtree of the book hierarchy.
menu_overview_form in drupal/core/modules/menu/menu.admin.inc
Form constructor to edit an entire menu tree at once.
TreeAccessTest::testRouteItemMenuLinksAccess in drupal/core/modules/system/lib/Drupal/system/Tests/Menu/TreeAccessTest.php
Tests access check for menu links with a route item.
TreeDataUnitTest::testMenuTreeData in drupal/core/modules/system/lib/Drupal/system/Tests/Menu/TreeDataUnitTest.php
Validate the generation of a proper menu tree hierarchy.
_menu_build_tree in drupal/core/includes/menu.inc
Builds a menu tree.

File

drupal/core/includes/menu.inc, line 1562
API for the Drupal menu system.

Code

function menu_tree_data(array $links, array $parents = array(), $depth = 1) {

  // Reverse the array so we can use the more efficient array_pop() function.
  $links = array_reverse($links);
  return _menu_tree_data($links, $parents, $depth);
}