FilterMenuItemsEvent

New in version 12.0

This event has been introduced to serve as a more powerful and flexible alternative for the removed hook $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/tslib/class.tslib_menu.php']['filterMenuPages'].

The PSR-14 event \TYPO3\CMS\Frontend\Event\FilterMenuItemsEvent has a variety of properties and getters, along with TYPO3\\CMS\\Frontend\\Event\\FilterMenuItemsEvent::getFilteredMenuItems() and TYPO3\\CMS\\Frontend\\Event\\FilterMenuItemsEvent::setFilteredMenuItems(). Those methods can be used to change the items of a menu, which has been generated with a TypoScript HMENU or a MenuProcessor.

This event is fired after TYPO3 has filtered all menu items. The menu can then be adjusted by adding, removing or modifying the menu items. Also changing the order is possible.

Additionally, more information about the currently rendered menu, such as the menu items which were filtered out, is available.

Example

API

class \TYPO3\CMS\Frontend\Event\ FilterMenuItemsEvent

Listeners to this Event will be able to modify items for a menu generated with HMENU

getAllMenuItems ( )
returntype

array

getFilteredMenuItems ( )
returntype

array

setFilteredMenuItems ( array $filteredMenuItems)
param array $filteredMenuItems

the filteredMenuItems

getMenuConfiguration ( )
returntype

array

getItemConfiguration ( )
returntype

array

getBannedMenuItems ( )
returntype

array

getExcludedDoktypes ( )
returntype

array

getSite ( )
returntype

TYPO3\CMS\Core\Site\Entity\Site

getContext ( )
returntype

TYPO3\CMS\Core\Context\Context

getCurrentPage ( )
returntype

array