AdminThemeFramework::getUserNavArray() method

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.

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.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer