Home › API reference › core.php
  1. drupal
    1. 4.7
    2. 5
    3. 6
    4. 7 system.api.php
Versions
4.7 – 5 hook_menu($may_cache)
6 – 7 hook_menu()

Define menu items and page callbacks.

This hook enables modules to register paths, which determines whose requests are to be handled. Depending on the type of registration requested by each path, a link is placed in the the navigation block and/or an item appears in the menu administration page (q=admin/menu).

This hook is called rarely - for example when modules are enabled.

http://drupal.org/node/102338 .

Return value

An array of menu items. Each menu item has a key corresponding to the Drupal path being registered. The item is an associative array that may contain the following key-value pairs:

  • "title": Required. The untranslated title of the menu item.
  • "title callback": Function to generate the title, defaults to t(). If you require only the raw string to be output, set this to FALSE.
  • "title arguments": Arguments to send to t() or your custom callback.
  • "description": The untranslated description of the menu item.
  • "page callback": The function to call to display a web page when the user visits the path. If omitted, the parent menu item's callback will be used instead.
  • "page arguments": An array of arguments to pass to the page callback function. Integer values pass the corresponding URL component (see arg()).
  • "access callback": A function returning a boolean value that determines whether the user has access rights to this menu item. Defaults to user_access() unless a value is inherited from a parent menu item..
  • "access arguments": An array of arguments to pass to the access callback function. Integer values pass the corresponding URL component.
  • "file": A file that will be included before the callbacks are accessed; this allows callback functions to be in separate files. The file should be relative to the implementing module's directory unless otherwise specified by the "file path" option.
  • "file path": The path to the folder containing the file specified in "file". This defaults to the path to the module implementing the hook.
  • "weight": An integer that determines relative position of items in the menu; higher-weighted items sink. Defaults to 0. When in doubt, leave this alone; the default alphabetical order is usually best.
  • "menu_name": Optional. Set this to a custom menu if you don't want your item to be placed in Navigation.
  • "type": A bitmask of flags describing properties of the menu item. Many shortcut bitmasks are provided as constants in menu.inc:

    • MENU_NORMAL_ITEM: Normal menu items show up in the menu tree and can be moved/hidden by the administrator.
    • MENU_CALLBACK: Callbacks simply register a path so that the correct function is fired when the URL is accessed.
    • MENU_SUGGESTED_ITEM: Modules may "suggest" menu items that the administrator may enable.
    • MENU_LOCAL_TASK: Local tasks are rendered as tabs by default.
    • MENU_DEFAULT_LOCAL_TASK: Every set of local tasks should provide one "default" task, that links to the same path as its parent when clicked.

    If the "type" key is omitted, MENU_NORMAL_ITEM is assumed.

For a detailed usage example, see page_example.module.

For comprehensive documentation on the menu system, see

Related topics

Hooks
Allow modules to interact with the Drupal core.

Code

developer/hooks/core.php, line 1163

<?php
function hook_menu() {
  $items = array();

  $items['blog'] = array(
    'title' => 'blogs', 
    'description' => 'Listing of blogs.', 
    'page callback' => 'blog_page', 
    'access arguments' => array('access content'), 
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['blog/feed'] = array(
    'title' => 'RSS feed', 
    'page callback' => 'blog_feed', 
    'access arguments' => array('access content'), 
    'type' => MENU_CALLBACK,
  );

  return $items;
}
?>