TemplateFile::fileFailed() method

Called when render of specific file failed with Exception

Available since version 3.0.154.

Usage

$bool = $templateFile->fileFailed(string $filename, \Exception $e);

Arguments

NameType(s)Description
filenamestring
e\Exception

Return value

bool

True if Exception $e should be thrown, false if it should be ignored


Hooking TemplateFile::fileFailed(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 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

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer