W3cubDocs

/Drupal 8

public function MenuActiveTrailInterface::getActiveLink

public MenuActiveTrailInterface::getActiveLink($menu_name = NULL)

Fetches a menu link which matches the route name, parameters and menu name.

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 given route name, parameters and menu, 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).

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);

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Menu!MenuActiveTrailInterface.php/function/MenuActiveTrailInterface::getActiveLink/8.1.x