AdminThemeFramework::getUserNavArray()

Get navigation items for the “user” menu

This is hookable so that something else could add stuff to it. See the method body for details on format used.

Supported properties/attributes as of 3.0.248:

  • url (href)
  • title (label text)
  • target (html attr)
  • icon (name of icon)
  • permission (required permission)
  • id (html attr)
  • class (html attr)
  • onclick (html attr)
  • data-* (html attr)

Usage

$array = $adminThemeFramework->getUserNavArray();

Return value

array


Hooking AdminThemeFramework::getUserNavArray()

You can add your own hook events that are executed either before or after the AdminThemeFramework::getUserNavArray() method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each AdminThemeFramework::getUserNavArray() method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('AdminThemeFramework::getUserNavArray', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $AdminThemeFramework = $event->object;

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

The 'after' hooks are called immediately after each AdminThemeFramework::getUserNavArray() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('AdminThemeFramework::getUserNavArray', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $AdminThemeFramework = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

AdminThemeFramework methods and properties

API reference based on ProcessWire core version 3.0.253