function MenuActiveTrailInterface::getActiveLink

Same name and namespace in other branches
  1. 10 core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php \Drupal\Core\Menu\MenuActiveTrailInterface::getActiveLink()
  2. 9 core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php \Drupal\Core\Menu\MenuActiveTrailInterface::getActiveLink()
  3. 8.9.x core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php \Drupal\Core\Menu\MenuActiveTrailInterface::getActiveLink()

Fetches a menu link that matches the currently active route.

Parameters

string|null $menu_name: (optional) The menu within which to find the active link. If omitted, all menus will be searched.

Return value

\Drupal\Core\Menu\MenuLinkInterface|null The menu link for the currently active route, or NULL if there is no matching menu link or the current user cannot access the current page (i.e. we have a 403 response).

2 methods override MenuActiveTrailInterface::getActiveLink()
MenuActiveTrail::getActiveLink in core/lib/Drupal/Core/ProxyClass/Menu/MenuActiveTrail.php
Fetches a menu link that matches the currently active route.
MenuActiveTrail::getActiveLink in core/lib/Drupal/Core/Menu/MenuActiveTrail.php
Fetches a menu link that matches the currently active route.

File

core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php, line 37

Class

MenuActiveTrailInterface
Defines an interface for the active menu trail service.

Namespace

Drupal\Core\Menu

Code

public function getActiveLink($menu_name = NULL);

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