menu.inc
Version
1.306 (checked in on 2008/11/15 at 11:45:03 by dries)
Description
API for the Drupal menu system.
Constants
Name | Description |
|---|---|
| MENU_ACCESS_DENIED | Internal menu status code -- Menu item access is denied. |
| MENU_CALLBACK | Menu type -- A hidden, internal callback, typically used for API calls. |
| MENU_CREATED_BY_ADMIN | Internal menu flag -- menu item was created by administrator. |
| MENU_DEFAULT_LOCAL_TASK | Menu type -- The "default" local task, which is initially active. |
| MENU_FOUND | Internal menu status code -- Menu item was found. |
| MENU_IS_LOCAL_TASK | Internal menu flag -- menu item is a local task. |
| MENU_IS_ROOT | Internal menu flag -- menu item is the root of the menu tree. |
| MENU_LINKS_TO_PARENT | Internal menu flag -- menu item links back to its parnet. |
| MENU_LOCAL_TASK | Menu type -- A task specific to the parent item, usually rendered as a tab. |
| MENU_MAX_DEPTH | The maximum depth of a menu links tree - matches the number of p columns. |
| MENU_MAX_PARTS | The maximum number of path elements for a menu callback |
| MENU_MODIFIED_BY_ADMIN | Internal menu flag -- menu item can be modified by administrator. |
| MENU_NORMAL_ITEM | Menu type -- A "normal" menu item that's shown in menu and breadcrumbs. |
| MENU_NOT_FOUND | Internal menu status code -- Menu item was not found. |
| MENU_SITE_OFFLINE | Internal menu status code -- Menu item inaccessible because site is offline. |
| MENU_SUGGESTED_ITEM | Menu type -- A normal menu item, hidden until enabled by an administrator. |
| MENU_VISIBLE_IN_BREADCRUMB | Internal menu flag -- menu item is visible in the breadcrumb. |
| MENU_VISIBLE_IN_TREE | Internal menu flag -- menu item is visible in the menu tree. |
Functions
| Name | Description |
|---|---|
| drupal_help_arg | Generates elements for the $arg array in the help hook. |
| menu_cache_clear | Clears the cached cached data for a single named menu. |
| menu_cache_clear_all | Clears all cached menu data. This should be called any time broad changes might have been made to the router items or menu links. |
| menu_execute_active_handler | Execute the page callback associated with the current path |
| menu_get_active_breadcrumb | Get the breadcrumb for the current page, as determined by the active trail. |
| menu_get_active_help | Returns the help associated with the active menu item. |
| menu_get_active_menu_name | Get the active menu for the current page - determines the active trail. |
| menu_get_active_title | Get the title of the current page, as determined by the active trail. |
| menu_get_active_trail | Get the active trail for the current page - the path to root in the menu tree. |
| menu_get_ancestors | Returns the ancestors (and relevant placeholders) for any given path. |
| menu_get_item | Get a router item. |
| menu_get_names | Build a list of named menus. |
| menu_get_object | Get a loaded object from a router item. |
| menu_link_children_relative_depth | Find the depth of an item's children relative to its depth. |
| menu_link_delete | Delete one or several menu links. |
| menu_link_load | Get a menu link by its mlid, access checked and link translated for rendering. |
| menu_link_maintain | Insert, update or delete an uncustomized menu link related to a module. |
| menu_link_save | Save a menu link. |
| menu_list_system_menus | Return an array containing the names of system-defined (default) menus. |
| menu_local_tasks | Collects the local tasks (tabs) for a given level. |
| menu_main_menu | Return an array of links to be rendered as the Main menu. |
| menu_navigation_links | Return an array of links for a navigation menu. |
| menu_path_is_external | Returns TRUE if a path is external (e.g. http://example.com). |
| menu_primary_local_tasks | Returns the rendered local tasks at the top level. |
| menu_rebuild | (Re)populate the database tables used by various menu functions. |
| menu_router_build | Collect, alter and store the menu definitions. |
| menu_secondary_local_tasks | Returns the rendered local tasks at the second level. |
| menu_secondary_menu | Return an array of links to be rendered as the Secondary links. |
| menu_set_active_item | Set the active path, which determines which page is loaded. |
| menu_set_active_menu_name | Set (or get) the active menu for the current page - determines the active trail. |
| menu_set_active_trail | Set (or get) the active trail for the current page - the path to root in the menu tree. |
| menu_set_item | Replaces the statically cached item for a given path. |
| menu_tab_root_path | Returns the router path, or the path of the parent tab of a default local task. |
| menu_tail_to_arg | |
| menu_tree | Render a menu tree based on the current path. |
| menu_tree_all_data | Get the data structure representing a named menu tree. |
| menu_tree_check_access | Check access and perform other dynamic operations for each link in the tree. |
| menu_tree_collect_node_links | Recursive helper function - collect node links. |
| menu_tree_data | Build the data representing a menu tree. |
| menu_tree_output | Returns a rendered menu tree. |
| menu_tree_page_data | Get the data structure representing a named menu tree, based on the current page. |
| menu_unserialize | The menu system uses serialized arrays stored in the database for arguments. However, often these need to change according to the current path. This function unserializes such an array and does the necessary change. |
| menu_valid_path | Validates the path of a menu link being created or edited. |
| theme_menu_item | Generate the HTML output for a menu item and submenu. |
| theme_menu_item_link | Generate the HTML output for a single menu link. |
| theme_menu_local_task | Generate the HTML output for a single local task link. |
| theme_menu_local_tasks | Returns the rendered local tasks. The default implementation renders them as tabs. |
| theme_menu_tree | Generate the HTML output for a menu tree |
| _menu_check_access | Check access to a menu item using the access callback |
| _menu_clear_page_cache | Helper function to clear the page and block caches at most twice per page load. |
| _menu_delete_item | Helper function for menu_link_delete; deletes a single menu link. |
| _menu_find_router_path | Find the router path which will serve this path. |
| _menu_item_localize | Localize the router item title using t() or another callback. |
| _menu_link_build | Builds a link from a router item. |
| _menu_link_map_translate | This function translates the path elements in the map using any to_arg helper function. These functions take an argument and return an object. See http://drupal.org/node/109153 for more information. |
| _menu_link_move_children | Update the children of a menu link that's being moved. |
| _menu_link_parents_set | Helper function that sets the p1..p9 values for a menu link being saved. |
| _menu_link_translate | This function is similar to _menu_translate() but does link-specific preparation such as always calling to_arg functions |
| _menu_load_objects | Loads objects into the map as defined in the $item['load_functions']. |
| _menu_navigation_links_rebuild | Helper function to build menu links for the items in the menu router. |
| _menu_router_build | Helper function to build the router table based on the data from hook_menu. |
| _menu_set_expanded_menus | Helper function to update a list of menus with expanded items |
| _menu_site_is_offline | Checks whether the site is offline for maintenance. |
| _menu_translate | Handles dynamic path translation and menu access control. |
| _menu_tree_check_access | Recursive helper function for menu_tree_check_access() |
| _menu_tree_cid | Helper function - compute the real cache ID for menu tree data. |
| _menu_tree_data | Recursive helper function to build the data representing a menu tree. |
| _menu_update_parental_status | Check and update the has_children status for the parent of a link. |