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
| Name | Type(s) | Description |
|---|---|---|
data (optional) | array | Additional data for hooks (3.0.147+ only):
|
Hooking $wire->finished(…)
You can add your own hook events that are executed either before or after the $wire 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 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 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;
});API reference based on ProcessWire core version 3.0.244