Hook called just before a user is saved

Usage

$array = $users->saveReady(Page $page);

Arguments

NameType(s)Description
$pagePage

The user about to be saved

Return value

array

Optional extra data to add to pages save query.

Hooking $users->saveReady(…)

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

$this->addHookBefore('Users::saveReady', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $users = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('Users::saveReady', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $users = $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)
  $page = $event->arguments(0);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$users methods and properties

API reference based on ProcessWire core version 3.0.115