$process->failed() method

Hook called when the pageview failed to finish due to an Exception or Error.

Sends a copy of the throwable that occurred.

Usage

// basic usage
$process->failed(\Throwable $e);

// usage with all arguments
$process->failed(\Throwable $e, string $reason = '', $page = null, string $url = '');

Arguments

NameType(s)Description
e\Throwable

Exception or Error

reason (optional)string
page (optional)Page, null
url (optional)string

Hooking $process->failed(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $e = $event->arguments(0);
  $reason = $event->arguments(1);
  $page = $event->arguments(2);
  $url = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $e);
  $event->arguments(1, $reason);
  $event->arguments(2, $page);
  $event->arguments(3, $url);
});

Hooking after

The 'after' hooks are called immediately after each $process->failed(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProcessPageView::failed', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $process = $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)
  $e = $event->arguments(0);
  $reason = $event->arguments(1);
  $page = $event->arguments(2);
  $url = $event->arguments(3);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$process methods and properties

API reference based on ProcessWire core version 3.0.244

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