menu_local_tasks
Definition
menu_local_tasks($level = 0)
drupal/includes/menu.inc, line 1664
Description
Collects the local tasks (tabs), action links, and the root path.
Parameters
$level The level of tasks you ask for. Primary tasks are 0, secondary are 1.
Return value
An array containing
- tabs: Local tasks for the requested level:
- count: The number of local tasks.
- output: The themed output of local tasks.
- actions: Action links for the requested level:
- count: The number of action links.
- output: The themed output of action links.
- root_path: The router path for the current page. If the current page is a default local task, then this corresponds to the parent tab.
Related topics
Name | Description |
|---|---|
| Menu system | Define the navigation menus, and route page requests to code based on URLs. |
Code
function menu_local_tasks($level = 0) {
$data = &drupal_static(__FUNCTION__);
$root_path = &drupal_static(__FUNCTION__ . ':root_path', '');
$empty = array(
'tabs' => array('count' => 0, 'output' => array()),
'actions' => array('count' => 0, 'output' => array()),
'root_path' => &$root_path,
);
if (!isset($data)) {
$data = array();
// Set defaults in case there are no actions or tabs.
$actions = $empty['actions'];
$tabs = array();
$router_item = menu_get_item();
if (!$router_item || !$router_item['access']) {
return $empty;
}
// Get all tabs and the root page.
$result = db_select('menu_router', NULL, array('fetch' => PDO::FETCH_ASSOC))
->fields('menu_router')
->condition('tab_root', $router_item['tab_root'])
->condition('context', MENU_CONTEXT_INLINE, '<>')
->orderBy('weight')
->orderBy('title')
->execute();
$map = $router_item['original_map'];
$children = array();
$tasks = array();
$root_path = $router_item['path'];
foreach ($result as $item) {
_menu_translate($item, $map, TRUE);
if ($item['tab_parent']) {
// All tabs, but not the root page.
$children[$item['tab_parent']][$item['path']] = $item;
}
// Store the translated item for later use.
$tasks[$item['path']] = $item;
}
// Find all tabs below the current path.
$path = ($router_item['type'] == MENU_DEFAULT_LOCAL_TASK ? $router_item['tab_parent'] : $router_item['path']);
// Tab parenting may skip levels, so the number of parts in the path may not
// equal the depth. Thus we use the $depth counter (offset by 1000 for ksort).
$depth = 1001;
$actions['count'] = 0;
$actions['output'] = array();
while (isset($children[$path])) {
$tabs_current = array();
$actions_current = array();
$next_path = '';
$tab_count = 0;
$action_count = 0;
foreach ($children[$path] as $item) {
if ($item['access']) {
$link = $item;
// The default task is always active.
if ($item['type'] == MENU_DEFAULT_LOCAL_TASK) {
// Find the first parent which is not a default local task or action.
for ($p = $item['tab_parent']; $tasks[$p]['type'] == MENU_DEFAULT_LOCAL_TASK; $p = $tasks[$p]['tab_parent']);
// Use the path of the parent instead.
$link['href'] = $tasks[$p]['href'];
$tabs_current[] = array(
'#theme' => 'menu_local_task',
'#link' => $link,
'#active' => TRUE,
);
$next_path = $item['path'];
$tab_count++;
}
else {
if ($item['type'] == MENU_LOCAL_TASK) {
$tabs_current[] = array(
'#theme' => 'menu_local_task',
'#link' => $link,
);
$tab_count++;
}
else {
$actions_current[] = array(
'#theme' => 'menu_local_action',
'#link' => $link,
);
$action_count++;
}
}
}
}
$path = $next_path;
$tabs[$depth]['count'] = $tab_count;
$tabs[$depth]['output'] = $tabs_current;
$actions['count'] += $action_count;
$actions['output'] = array_merge($actions['output'], $actions_current);
$depth++;
}
$data['actions'] = $actions;
// Find all tabs at the same level or above the current one.
$parent = $router_item['tab_parent'];
$path = $router_item['path'];
$current = $router_item;
$depth = 1000;
while (isset($children[$parent])) {
$tabs_current = array();
$next_path = '';
$next_parent = '';
$count = 0;
foreach ($children[$parent] as $item) {
if ($item['type'] & MENU_IS_LOCAL_ACTION) {
continue;
}
if ($item['access']) {
$count++;
$link = $item;
if ($item['type'] == MENU_DEFAULT_LOCAL_TASK) {
// Find the first parent which is not a default local task.
for ($p = $item['tab_parent']; $tasks[$p]['type'] == MENU_DEFAULT_LOCAL_TASK; $p = $tasks[$p]['tab_parent']);
// Use the path of the parent instead.
$link['href'] = $tasks[$p]['href'];
if ($item['path'] == $router_item['path']) {
$root_path = $tasks[$p]['path'];
}
}
// We check for the active tab.
if ($item['path'] == $path) {
$tabs_current[] = array(
'#theme' => 'menu_local_task',
'#link' => $link,
'#active' => TRUE,
);
$next_path = $item['tab_parent'];
if (isset($tasks[$next_path])) {
$next_parent = $tasks[$next_path]['tab_parent'];
}
}
else {
$tabs_current[] = array(
'#theme' => 'menu_local_task',
'#link' => $link,
);
}
}
}
$path = $next_path;
$parent = $next_parent;
$tabs[$depth]['count'] = $count;
$tabs[$depth]['output'] = $tabs_current;
$depth--;
}
// Sort by depth.
ksort($tabs);
// Remove the depth, we are interested only in their relative placement.
$tabs = array_values($tabs);
$data['tabs'] = $tabs;
// Allow modules to alter local tasks or dynamically append further tasks.
drupal_alter('menu_local_tasks', $data, $router_item, $root_path);
}
if (isset($data['tabs'][$level])) {
return array(
'tabs' => $data['tabs'][$level],
'actions' => $data['actions'],
'root_path' => $root_path,
);
}
// @todo If there are no tabs, then there still can be actions; for example,
// when added via hook_menu_local_tasks_alter().
elseif (!empty($data['actions']['output'])) {
return array('actions' => $data['actions']) + $empty;
}
return $empty;
}