AdminThemeFramework::renderFile()

Render a admin theme template file

This method is only used if it is hooked

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Available since version 3.0.196.

Internal usage

// basic internal usage
$string = $adminThemeFramework->renderFile(string $file);

// internal usage with all arguments
$string = $adminThemeFramework->renderFile(string $file, array $vars = []);

Arguments

NameType(s)Description
$filestring

Full path and filename

$vars (optional)array

Associative array of variables to populate in rendered file

Return value

string

Returns blank string when $echo is true


Hooking AdminThemeFramework::renderFile(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $file = $event->arguments(0);
  $vars = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $file);
  $event->arguments(1, $vars);
});

Hooking after

The 'after' hooks are called immediately after each AdminThemeFramework::renderFile(…) 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::renderFile', 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;

  // Get values of arguments sent to hook (if needed)
  $file = $event->arguments(0);
  $vars = $event->arguments(1);

  /* 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.251