Menu Pager

Categories

Component ID

2824382

Component name

Menu Pager

Component type

module

Maintenance status

Development status

Component security advisory coverage

covered

Downloads

399

Component created

Component changed

Component body

Menu Pager adds a block for each menu that adds previous and next link navigation based on the current page.

It does this by flattening the menu tree to calculate which links should come before and after the menu link corresponding to the current page. This can optionally be restricted to links with the same parent as the active menu link (by default, it uses traverses the entire menu tree).

API

Menu Pager provides a simple API for retrieving previous and next links for a given menu item.

$navigation = menu_pager_get_navigation($menu_link);
// $navigation['previous'] and $navigation['next'] will contain the links

There are hooks to ignore certain paths from appearing in menu pagers.

Out-of-the-box support is included to ignore <nolink> and <separator> paths from Special Menu Items and <firstchild> from Menu Firstchild.

Add your own paths with hook_menu_pager_ignore_paths($menu_name) and hook_menu_pager_ignore_paths_alter(&$paths, $menu_name).