Wire::trackException() method

Hookable method called when an Exception occurs

  • It will log Exception to exceptions.txt log if 'exceptions' is in $config->logs.
  • It will re-throw Exception if $config->allowExceptions is true.
  • If additional $text is provided, it will be sent to notice method call.

Usage

// basic usage
$wire->trackException($e);

// usage with all arguments
$wire->trackException($e, $severe = true, $text = null);

Arguments

NameType(s)Description
e\Exception, WireException

Exception object that was thrown.

severe (optional)bool, int

Whether or not it should be considered severe (default=true).

text (optional)string, array, object, true

Additional details (optional):

  • When provided, it will be sent to $this->error($text) if $severe is true, or $this->warning($text) if $severe is false.
  • Specify boolean true to just send the $e->getMessage() to $this->error() or $this->warning().

Return value

$this

Object instance it was called from (method supports fluent interface).

Exceptions

Method can throw exceptions on error:

  • \Exception - If $severe==true and $config->allowExceptions==true


Hooking Wire::trackException(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each Wire::trackException(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Wire::trackException', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Wire = $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);
  $severe = $event->arguments(1);
  $text = $event->arguments(2);

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

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

Wire methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • Stumbling upon a really nice ProcessWire-powered website, plus core updates including API improvements for ProcessWire forms— More
    9 September 2022
  • Useful new dot-and-bracket syntax options added for page.get() method— More
    2 September 2022
  • This week, in addition to the regular core updates, we have new versions of ProcessWire ProFields Table and ProFields Combo that add support for their own file and image types— More
    19 August 2022

Latest news

  • ProcessWire Weekly #437
    In the 437th issue of ProcessWire Weekly we're going to check out the latest core updates, forum highlights and online resources, and more. Read on!
    Weekly.pw / 24 September 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • 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