You are here

Home » API reference » Drupal 9 » menu.api.php

function hook_menu_links_discovered_alter in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Menu/menu.api.php \hook_menu_links_discovered_alter()
  2. 10 core/lib/Drupal/Core/Menu/menu.api.php \hook_menu_links_discovered_alter()

Alters all the menu links discovered by the menu link plugin manager.

Parameters

array $links: The link definitions to be altered.

Return value

array An array of discovered menu links. Each link has a key that is the machine name, which must be unique. By default, use the route name as the machine name. In cases where multiple links use the same route name, such as two links to the same page in different menus, or two links using the same route name but different route parameters, the suggested machine name patten is the route name followed by a dot and a unique suffix. For example, an additional logout link might have a machine name of user.logout.navigation, and default links provided to edit the article and page content types could use machine names entity.node_type.edit_form.article and entity.node_type.edit_form.page. Since the machine name may be arbitrary, you should never write code that assumes it is identical to the route name.

The value corresponding to each machine name key is an associative array that may contain the following key-value pairs:

  • title: (required) The title of the menu link. If this should be translated, create a \Drupal\Core\StringTranslation\TranslatableMarkup object.
  • description: The description of the link. If this should be translated, create a \Drupal\Core\StringTranslation\TranslatableMarkup object.
  • route_name: (optional) The route name to be used to build the path. Either the route_name or url element must be provided.
  • route_parameters: (optional) The route parameters to build the path.
  • url: (optional) If you have an external link use this element instead of providing route_name.
  • parent: (optional) The machine name of the link that is this link's menu parent.
  • weight: (optional) An integer that determines the relative position of items in the menu; higher-weighted items sink. Defaults to 0. Menu items with the same weight are ordered alphabetically.
  • menu_name: (optional) The machine name of a menu to put the link in, if not the default Tools menu.
  • expanded: (optional) If set to TRUE, and if a menu link is provided for this menu item (as a result of other properties), then the menu link is always expanded, equivalent to its 'always expanded' checkbox being set in the UI.
  • options: (optional) An array of options to be passed to \Drupal\Core\Utility\LinkGeneratorInterface::generate() when generating a link from this menu item.

Related topics

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

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

content_translation_menu_links_discovered_alter in core/modules/content_translation/content_translation.module
Implements hook_menu_links_discovered_alter().
dblog_menu_links_discovered_alter in core/modules/dblog/dblog.module
Implements hook_menu_links_discovered_alter().
editor_menu_links_discovered_alter in core/modules/editor/editor.module
Implements hook_menu_links_discovered_alter().
lazy_route_provider_install_test_menu_links_discovered_alter in core/modules/system/tests/modules/lazy_route_provider_install_test/lazy_route_provider_install_test.module
Implements hook_menu_links_discovered_alter().
menu_test_menu_links_discovered_alter in core/modules/system/tests/modules/menu_test/menu_test.module
Implements hook_menu_links_discovered_alter().
1 invocation of hook_menu_links_discovered_alter()
MenuLinkManager::getDefinitions in core/lib/Drupal/Core/Menu/MenuLinkManager.php
Gets the definition of all plugins for this type.

File

core/lib/Drupal/Core/Menu/menu.api.php, line 271
Hooks and documentation related to the menu system and links.

Code

function hook_menu_links_discovered_alter(&$links) {

  // Change the weight and title of the user.logout link.
  $links['user.logout']['weight'] = -10;
  $links['user.logout']['title'] = new \Drupal\Core\StringTranslation\TranslatableMarkup('Logout');

  // Conditionally add an additional link with a title that's not translated.
  if (\Drupal::moduleHandler()
    ->moduleExists('search')) {
    $links['menu.api.search'] = [
      'title' => \Drupal::config('system.site')
        ->get('name'),
      'route_name' => 'menu.api.search',
      'description' => new \Drupal\Core\StringTranslation\TranslatableMarkup('View popular search phrases for this site.'),
      'parent' => 'system.admin_reports',
    ];
  }
}