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

Twitter updates

  • ProcessWire 3.0.158 core updates — More
    29 May 2020
  • ProcessWire 3.0.157 core updates— More
    23 May 2020
  • ProcessWire 3.0.156 core updates— More
    15 May 2020

Latest news

  • ProcessWire Weekly #316
    In the 316th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new third party modules, and check out the website of a very interesting German online event. Read on!
    Weekly.pw / 30 May 2020
  • ProcessWire 3.0.154 and 3.0.155 core updates
    This post covers a few of the bigger updates in ProcessWire 3.0.154 and 3.0.155 on the dev branch. This includes a new function for live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our $input->urlSegment() method that I think you’ll like!
    Blog / 24 April 2020
  • 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