$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.244

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK