hook_menu

developer/hooks/core.php, строка 1076

Версии
5: hook_menu($may_cache)
6: hook_menu()

Определяет пункты меню и обратный вызов страниц.

Этот хук разрешает модулям регистрировать пути, которые определяют запросы, подлежащие обработке. В зависимости от типа регистрации, запрошенного для каждого пути, ссылка помещается в блоке навигации и/или пункт появляется в меню административной страницы ('q=admin/menu').

Этот хук часто вызывается, например, при включении модуля.

'title': Обязательно. Непереведенное название пункта меню.
'title callback': Функция для генерации названия пункта меню, по умолчанию t(). Если вы хотите вывести необработанные строки, установите этот параметр в FALSE.
'title arguments': Аргументы для функции t() или вашей персональной функции.
'description': Непереведенное описание пункта меню.
'page callback': Имя функции, вызываемой для отображения страницы, когда пользователь переходит по пункту меню. Если пропущено, будет вызвана функция родительского пункта меню.
'page arguments': Массив аргументов, передаваемых функции 'page callback'. Целочисленные значения соответствуют частям URL (см. функцию arg()).
'access callback': Имя функции, возвращающей булево значение, определяющее, имеет ли пользователь права доступа к этому пункту меню. По-умолчанию — user_access() или функция доступа родительского пункта меню.
'access arguments': Массив аргументов, передаваемых в функцию 'access callback'. Целочисленные значения соответствуют частям URL.
'weight': Целочисленное значение, обозначающее позицию пункта в меню. По умолчанию равно 0. Если не уверены, не указывайте это значение, сортировка по алфавиту почти всегда лучше.
'menu_name': (опционально) Название меню, в которое следует поместить пункт. По-умолчанию пункты меню помещаются в меню Navigation.
'type': Тип пункта меню из списка:
- MENU_NORMAL_ITEM: Нормальный пункт, который показывается в древе меню и может быть передвинут/скрыт администратором.
- MENU_CALLBACK: Регистрирует функцию, которая что-то возвращает по соответствующему пути.
- MENU_SUGGESTED_ITEM: Модули могут "предлагать" администратору пункты, которые полезно включить.
- MENU_LOCAL_TASK: Локальные задачи отображаются как табы.
- MENU_DEFAULT_LOCAL_TASK: Каждый набор локальных задач должен иметь одну по-умолчанию, которая ссылается на родительский пункт меню.
Если параметр 'type' пропущен, он устанавливается в MENU_NORMAL_ITEM по-умолчанию.

Примеры использования — page_example.module.

Возвращаемое значение

Массив пунктов меню. Каждый пункт меню имеет ключ, который согласуется с путём, который зарегистрирован в Drupal. Пункт - это ассоциативный массив, который содержит следующие пары ключ-значение:

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.

"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.
"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 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:

Связанные темы

▸ 1 функция вызывает hook_menu()

▾ 1 функция вызывает hook_menu()

menu_router_build in includes/menu.inc: Собирает, изменяет и хранит определения меню и элементов.

Код

<?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;
}
?>

Пользовательские комментарии

#1 2009-07-08, VladSavitsky

Есть ещё один аттрибут - 'file', который указывает на то, что код обработчика нужно искать в этом файле.
Пример:
'file' => 'keywords.pages.inc',

#2 2009-10-18, voledy

так же есть еще аттрибут - 'load arguments', необходмый для передачи дополнительных параметров в "параметризованную функцию" пункта меню.

пример

'load arguments' => array('example1','example2');

предоставит два дополнительных параметра.

существует также еще несколько специальных параметра для 'load arguments'
'%map' - содержит массив всех параметров пункта меню
'%index' - позиция "параметризованной функции" в списке параметров пункта меню

пример

'load arguments' => array('%map', '%index')

расписал уж очень поверхностно.
инфа в книге "Pro drupal Develoment 6" John K. VanDyk , Chapter 4, page 78

Войдите или зарегистрируйтесь, чтобы получить возможность отправлять комментарии