function hook_local_tasks_alter

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Menu/menu.api.php \hook_local_tasks_alter()
  2. 10 core/lib/Drupal/Core/Menu/menu.api.php \hook_local_tasks_alter()
  3. 9 core/lib/Drupal/Core/Menu/menu.api.php \hook_local_tasks_alter()
  4. 8.9.x core/lib/Drupal/Core/Menu/menu.api.php \hook_local_tasks_alter()

Alter local tasks plugins.

Parameters

array $local_tasks: The array of local tasks plugin definitions, keyed by plugin ID.

See also

\Drupal\Core\Menu\LocalTaskInterface

\Drupal\Core\Menu\LocalTaskManager

hook_menu_local_tasks_alter()

Related topics

Menu system
Define the navigation menus, local actions and tasks, and contextual links.
Hooks
Define functions that alter the behavior of Drupal core.
5 functions implement hook_local_tasks_alter()

Note: the procedural functions in this list are found by pattern matching, so the list may include some functions that are not actually implementations of this hook.

FieldUiHooks::localTasksAlter in core/modules/field_ui/src/Hook/FieldUiHooks.php
Implements hook_local_tasks_alter().
MediaLibraryHooks::localTasksAlter in core/modules/media_library/src/Hook/MediaLibraryHooks.php
Implements hook_local_tasks_alter().
NodeMenuHooks::localTasksAlter in core/modules/node/src/Hook/NodeMenuHooks.php
Implements hook_local_tasks_alter().
TaxonomyHooks::localTasksAlter in core/modules/taxonomy/src/Hook/TaxonomyHooks.php
Implements hook_local_tasks_alter().
ViewsHooks::localTasksAlter in core/modules/views/src/Hook/ViewsHooks.php
Implements hook_local_tasks_alter().
1 invocation of hook_local_tasks_alter()
LocalTaskManager::__construct in core/lib/Drupal/Core/Menu/LocalTaskManager.php
Constructs a \Drupal\Core\Menu\LocalTaskManager object.

File

core/lib/Drupal/Core/Menu/menu.api.php, line 362

Code

function hook_local_tasks_alter(&$local_tasks) {
  // Remove a specified local task plugin.
  unset($local_tasks['example_plugin_id']);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.