TemplateFile::render() method

Render the template: execute it and return its output

Usage

$string = $templateFile->render();

Return value

string

The output of the Template File

Exceptions

Method can throw exceptions on error:

WireException or \Exception - Throws WireException if file not exist + any exceptions thrown by included file(s)

Hooking TemplateFile::render()

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

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

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

TemplateFile methods and properties

API reference based on ProcessWire core version 3.0.244