Wire::trackException()

Hookable method called when an Exception (or Error) occurs

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

Please note that if your root /index.php version is less than 302 it will only receive Exception (and not Error) objects.

Usage

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

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

Arguments

NameType(s)Description
$e\Throwable

Exception or Error 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 or \Error - 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.252