function menu_tree_set_path

Sets the path for determining the active trail of the specified menu tree.

This path will also affect the breadcrumbs under some circumstances. Breadcrumbs are built using the preferred link returned by menu_link_get_preferred(). If the preferred link is inside one of the menus specified in calls to menu_tree_set_path(), the preferred link will be overridden by the corresponding path returned by menu_tree_get_path().

Setting this path does not affect the main content; for that use menu_set_active_item() instead.

Parameters

$menu_name: The name of the affected menu tree.

$path: The path to use when finding the active trail.

Related topics

Menu system
Define the navigation menus, and route page requests to code based on URLs.
2 calls to menu_tree_set_path()
menu_test_menu_trail_callback in drupal/core/modules/system/tests/modules/menu_test/menu_test.module
Callback that test menu_test_menu_tree_set_path().
menu_tree_get_path in drupal/core/includes/menu.inc
Gets the path for determining the active trail of the specified menu tree.

File

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

Code

function menu_tree_set_path($menu_name, $path = NULL) {
  $paths =& drupal_static(__FUNCTION__);
  if (isset($path)) {
    $paths[$menu_name] = $path;
  }
  return isset($paths[$menu_name]) ? $paths[$menu_name] : NULL;
}