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

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 December 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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK