Home › API reference › menu.inc

menu_tree

  1. drupal
    1. 4.7 menu.inc
    2. 5 menu.inc
    3. 6
    4. 7
Versions
4.7 – 5 menu_tree($pid = 1)
6 menu_tree($menu_name = 'navigation')
7 menu_tree($menu_name)

Renders a menu tree based on the current path.

The tree is expanded based on the current path and dynamic paths are also changed according to the defined to_arg functions (for example the 'My account' link is changed from user/% to a link with the current user's uid).

Parameters

$menu_name The name of the menu.

Return value

A structured array representing the specified menu on the current page, to be rendered by drupal_render().

Related topics

Menu system
Define the navigation menus, and route page requests to code based on URLs.

▸ 3 functions call menu_tree()

▾ 3 functions call menu_tree()

menu_block_view in drupal/modules/menu/menu.module
Implements hook_block_view().
shortcut_renderable_links in drupal/modules/shortcut/shortcut.module
Returns an array of shortcut links, suitable for rendering.
system_block_view in drupal/modules/system/system.module
Implements hook_block_view().

Code

drupal/includes/menu.inc, line 973

<?php
function menu_tree($menu_name) {
  $menu_output = &drupal_static(__FUNCTION__, array());

  if (!isset($menu_output[$menu_name])) {
    $tree = menu_tree_page_data($menu_name);
    $menu_output[$menu_name] = menu_tree_output($tree);
  }
  return $menu_output[$menu_name];
}
?>