$wire->finished() method

Hookable ready for anyone that wants to hook when the request is finished

Usage

// basic usage
$wire->finished();

// usage with all arguments
$wire->finished(array $data = []);

Arguments

NameType(s)Description
data (optional)array

Additional data for hooks (3.0.147+ only):

  • maintenance (bool): Allow maintenance to run? (default=true)
  • prevStatus (int): Previous status before finished status (render, download or failed).
  • exited (bool): True if request was exited before finished (ProcessWire instance destructed before expected). 3.0.180+
  • redirectUrl (string): Contains redirect URL only if request ending with redirect (not present otherwise).
  • redirectType (int): Contains redirect type 301 or 302, only if requestUrl property is also present.

Hooking $wire->finished(…)

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

$this->addHookBefore('ProcessWire::finished', 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)
  $data = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('ProcessWire::finished', 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)
  $data = $event->arguments(0);

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

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

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