Documentation & API reference
Functions
Primary tabs
| Name | Location | Description | Direct uses |
Strings |
|---|---|---|---|---|
| menu_tail_load |
drupal/ |
Loads the path as one string relative to the current index. | ||
| _menu_link_translate |
drupal/ |
Provides menu link access control, translation, and argument handling. | 7 | |
| menu_item_route_access |
drupal/ |
Checks access to a menu item by mocking a request for a path. | 2 | |
| menu_get_object |
drupal/ |
Gets a loaded object from a router item. | 12 | |
| menu_tree_output |
drupal/ |
Returns a rendered menu tree. | 7 | |
| menu_tree_set_path |
drupal/ |
Sets the path for determining the active trail of the specified menu tree. | 2 | |
| menu_tree_get_path |
drupal/ |
Gets the path for determining the active trail of the specified menu tree. | 1 | |
| menu_build_tree |
drupal/ |
Builds a menu tree, translates links, and checks access. | 5 | |
| menu_tree_collect_node_links |
drupal/ |
Collects node links from a given menu tree recursively. | 3 | |
| menu_tree_check_access |
drupal/ |
Checks access and performs dynamic operations for each link in the tree. | 4 | |
| _menu_tree_check_access |
drupal/ |
Sorts the menu tree and recursively checks access for each item. | 1 | |
| menu_tree_data |
drupal/ |
Sorts and returns the built data representing a menu tree. | 5 | |
| _menu_tree_data |
drupal/ |
Builds the data representing a menu tree. | 1 | |
| template_preprocess_menu_tree |
drupal/ |
Implements template_preprocess_HOOK() for theme_menu_tree(). | ||
| theme_menu_tree |
drupal/ |
Returns HTML for a wrapper for a menu sub-tree. | ||
| theme_menu_link |
drupal/ |
Returns HTML for a menu link and submenu. | ||
| theme_menu_local_task |
drupal/ |
Returns HTML for a single local task link. | ||
| theme_menu_local_action |
drupal/ |
Returns HTML for a single local action link. | ||
| drupal_help_arg |
drupal/ |
Generates elements for the $arg array in the help hook. | 5 | |
| menu_get_active_help |
drupal/ |
Returns the help associated with the active menu item. | 1 | |
| menu_get_custom_theme |
drupal/ |
Gets the custom theme for the current page, if there is one. | 3 | |
| menu_set_custom_theme |
drupal/ |
Sets a custom theme for the current page, if there is one. | 2 | |
| menu_list_system_menus |
drupal/ |
Returns an array containing the names of system-defined (default) menus. | 11 | |
| menu_main_menu |
drupal/ |
Returns an array of links to be rendered as the Main menu. | 1 | |
| menu_secondary_menu |
drupal/ |
Returns an array of links to be rendered as the Secondary links. | 1 | |
| menu_navigation_links |
drupal/ |
Returns an array of links for a navigation menu. | 2 | |
| menu_local_tasks |
drupal/ |
Collects the local tasks (tabs), action links, and the root path. | 4 | |
| menu_contextual_links |
drupal/ |
Retrieves contextual links for a path based on registered local tasks. | 1 | |
| menu_primary_local_tasks |
drupal/ |
Returns the rendered local tasks at the top level. | 2 | |
| menu_secondary_local_tasks |
drupal/ |
Returns the rendered local tasks at the second level. | 1 | |
| menu_get_local_actions |
drupal/ |
Returns the rendered local actions at the current level. | 1 | |
| menu_tab_root_path |
drupal/ |
Returns the router path, or the path for a default local task's parent. | 1 | |
| menu_local_tabs |
drupal/ |
Returns a renderable element for the primary and secondary tabs. | 1 | |
| theme_menu_local_tasks |
drupal/ |
Returns HTML for primary and secondary local tasks. | ||
| menu_set_active_menu_names |
drupal/ |
Sets (or gets) the active menu for the current page. | 2 | |
| menu_get_active_menu_names |
drupal/ |
Gets the active menu for the current page. | 2 | |
| menu_set_active_item |
drupal/ |
Sets the active path, which determines which page is loaded. | ||
| menu_get_active_trail |
drupal/ |
Gets the active trail (path to root menu root) of the current page. | 5 | |
| menu_get_active_breadcrumb |
drupal/ |
Gets the breadcrumb for the current page, as determined by the active trail. | 2 | |
| menu_cache_clear |
drupal/ |
Clears the cached cached data for a single named menu. | 2 | |
| menu_cache_clear_all |
drupal/ |
Clears all cached menu data. | 7 | |
| menu_reset_static_cache |
drupal/ |
Resets the menu system static cache. | 4 | |
| menu_router_rebuild |
drupal/ |
Populates the database tables used by various menu functions. | 22 | |
| menu_router_build |
drupal/ |
Collects and alters the menu definitions. | 2 | |
| _menu_router_translate_route |
drupal/ |
Translates a route name to its router item path. | 2 | |
| _menu_router_cache |
drupal/ |
Stores the menu router if we have it in memory. | 3 | |
| menu_get_router |
drupal/ |
Gets the menu router. | 3 | |
| _menu_navigation_links_rebuild |
drupal/ |
Builds menu links for the items in the menu router. | 1 | |
| menu_load_links |
drupal/ |
Returns an array containing all links for a menu. | 3 | |
| menu_delete_links |
drupal/ |
Deletes all links for a menu. | 2 |