$process->finished() method

Hook called with the pageview has been finished and output has been sent. Note this is called in /index.php.

Usage

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

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

Arguments

Name	Type(s)	Description
`data` (optional)	array

Hooking $process->finished(…)

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

$this->addHookBefore('ProcessPageView::finished', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $process = $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 $process->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('ProcessPageView::finished', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $process = $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;
});

$process methods and properties

API reference based on ProcessWire core version 3.0.236