menu_tree_data

Versions
6: menu_tree_data($result = NULL, $parents = array(), $depth = 1)
7: menu_tree_data(array $links, array $parents = array(), $depth = 1)

Build the data representing a menu tree.

Parameters

$links An array of links (associative arrays) ordered by p1..p9.

$parents An array of the plid values that represent the path from the current page to the root of the menu tree.

$depth The minimum depth of any link in the $links array.

Return value

See menu_tree_page_data for a description of the data structure.

Related topics

▸ 4 functions call menu_tree_data()

▾ 4 functions call menu_tree_data()

book_menu_subtree_data in modules/book/book.module: Get the data representing a subtree of the book hierarchy.
menu_overview_form in modules/menu/menu.admin.inc: Form for editing an entire menu tree at once.
menu_tree_all_data in includes/menu.inc: Get the data structure representing a named menu tree.
menu_tree_page_data in includes/menu.inc: Get the data structure representing a named menu tree, based on the current page.

Code

includes/menu.inc, line 1316

<?php
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);
}
?>

Login or register to post comments

All source code and documentation on this site is released under the terms of the GNU General Public License, version 2 and later. Drupal is a registered trademark of Dries Buytaert.