$user->changed() method

Hook called when field has changed

  • Enables hooks to monitor changes to the object.
  • Do not call this method directly, as the Wire::trackChange() method already does so.
  • Descending classes should call $this->trackChange('name', $oldValue, $newValue); when a property they are tracking has changed.

Usage

// basic usage
$user->changed(string $what);

// usage with all arguments
$user->changed(string $what, mixed $old = null, mixed $new = null);

Arguments

NameType(s)Description
whatstring

Name of property that changed

old (optional)mixed

Previous value before change

new (optional)mixed

New value


Hooking $user->changed(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $what = $event->arguments(0);
  $old = $event->arguments(1);
  $new = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $what);
  $event->arguments(1, $old);
  $event->arguments(2, $new);
});

Hooking after

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

$this->addHookAfter('User::changed', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $user = $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)
  $what = $event->arguments(0);
  $old = $event->arguments(1);
  $new = $event->arguments(2);

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

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

See Also


$user methods and properties

API reference based on ProcessWire core version 3.0.135

Twitter updates

  • New post: A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email— More
    19 July 2019
  • New post: Version 3.0.135 of ProcessWire on the dev branch focuses on some .htaccess updates, adds clarity to debug mode, and improves upon the installer— More
    5 July 2019
  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019

Latest news

  • ProcessWire Weekly #271
    In the 271st issue of ProcessWire Weekly we're going to introduce two brand new WireMail modules, a new Textformatter module from BitPoet, and a brand new markup module from Chris Thomson. Read on!
    Weekly.pw / 20 July 2019
  • Two new WireMail modules and using Gmail with PW
    A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email.
    Blog / 19 July 2019
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer