AdminTheme::getExtraMarkup() method

Enables hooks to append extra markup to various sections of the admin page

Usage

$array = $adminTheme->getExtraMarkup();

Return value

array

Associative array containing the following properties, any ofwhich may be populated or empty:

  • head
  • body
  • masthead
  • content
  • footer
  • sidebar

Hooking AdminTheme::getExtraMarkup()

You can add your own hook events that are executed either before or after the AdminTheme::getExtraMarkup() 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 AdminTheme::getExtraMarkup() method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('AdminTheme::getExtraMarkup', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $AdminTheme = $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 AdminTheme::getExtraMarkup() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('AdminTheme::getExtraMarkup', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $AdminTheme = $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;
});

AdminTheme methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani