How can I get the active menu trail for the current page?

Question

If I use Drupal::menuTree() to load a menu it seems to always have inActiveTrail set to FALSE for all my items.

As an example consider the following code:

$menu_tree = Drupal::menuTree();
$parameters = new MenuTreeParameters();
$parameters->setTopLevelOnly();
$main_menu_top_level = $menu_tree->load('main', $parameters);

That code returns the top level of the main menu with inActiveTrail = FALSE for all items regardless of what page I am on.

I believe MenuTreeParameters::setActiveTrail() is meant to help here but then I have to pass in an active trail.

How do I get the active menu trail for the current page load so I can then pass it in?

Answer 1

MenuLinkTreeInterface::getCurrentRouteMenuTreeParameters() is what you want. To use the example above:

$menu_tree = Drupal::menuTree();
$parameters = $menu_tree->getCurrentRouteMenuTreeParameters('main');
$parameters->setTopLevelOnly();
$main_menu_top_level = $menu_tree->load('main', $parameters);

The resulting menu tree should have inActiveTrail flagged.

Answer 2

Use the active menu trail service, menu.active_trail, returns \Drupal\Core\Menu\MenuActiveTrailInterface. You can then use it to identify the active trail(s), and then retrieve it from the menu tree(s). Saves a foreach loop over the various menu items and testing for inActiveTrail.

$ids = $this->activeTrail->getActiveTrailIds('main'); $parameters = (new MenuTreeParameters())->setActiveTrail($ids); $tree = $this->linkTree->load('main', $parameters); $active = $tree[reset($ids)]; // There may be more than one...