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

Twitter updates

  • ProcessWire 3.0.146 on the dev branch contains about 22 commits with a combination of useful upgrades and issue report resolutions, more details in this forum post: More
    22 November 2019
  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019
  • ProcessWire 3.0.144 core updates: Upgraded overrides section in the field editor, a new Inputfields JS API, and more— More
    1 November 2019

Latest news

  • ProcessWire Weekly #290
    In the 290th issue of ProcessWire Weekly we're going to introduce the latest addition to the ProDevTools module package and a third party image picker field from gebeer, check out a new site of the week, and more. Read on!
    Weekly.pw / 30 November 2019
  • New User Activity module
    Blog / 29 November 2019
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits