Setup Main Menu

public function onSetupEmployeesAreaMainMenu(array &$menu) : void

Fires before displaying the main menu in the Employees Area.

Description

Trigger hook to allow the plugins to alter the items of the main menu displayed within the Employees Area.

Here it is possible to attach new items or detach/edit existing ones.

The items of the menu are associative arrays, which should specify the following attributes:

 The new items to push within the array must be registered with a unique key.

Parameters

&$menu

(array)  The main menu array.

Return Value

None.

Example

The example below replicates the "Coupons" menu item of the sidebar also under the main menu.

/**
 * Trigger hook to allow the plugins to alter the items of the main menu
 * displayed within the Employees Area.
 *
 * @param   array  &$menu  The main menu.
 *
 * @return  void
 */
public function onSetupEmployeesAreaMainMenu(&$menu)
{
    // include the coupon codes item within the main menu
    $menu['coupons'] = [
        'separator' => false,
        'title'     => JText::_('VAPEMPCOUPONSTITLE'),
        'icon'      => null,
        'query'     => [
            'view' => 'empcoupons',
        ],
    ];
}

Changelog