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

Twitter updates

  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019
  • New post: This week we look at the latest version of ProcessWire, 3.0.127 with nearly 30 new commits resolving dozens of older issue reports and a couple useful new features— More
    1 March 2019
  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019

Latest news

  • ProcessWire Weekly #253
    In the 253rd issue of ProcessWire Weekly we'll introduce the ProMailer Pro module, cover the upgrade made to our support forum software, check out Sanitizer Transliterate, and pick a new site of the week. Read on!
    Weekly.pw / 16 March 2019
  • ProcessWire ProMailer now available
    This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more.
    Blog / 15 March 2019
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH