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

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.