$users->save() method

Save a User

This is the same as calling $user->save()
If the user is new, it will be inserted. If existing, it will be updated.
If you want to just save a particular field for the user, use $user->save($fieldName) instead.

Hook note:
If you want to hook this method, please hook the Users::saveReady, Users::saved, or any one of the Pages::save* hook methods instead, as this method will not capture users saved directly through $pages->save($user).

Example

// Example of hooking $pages->save() on User objects only
$wire->addHookBefore('Pages::save(<User>)', function(HookEvent $e) {
  $user = $event->arguments(0);
});

Usage

$bool = $users->save(Page $page);

Arguments

Name	Type(s)	Description
`page`	Page

Return value

bool

True on success

Exceptions

Method can throw exceptions on error:

WireException

Hooking $users->save(…)

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

$this->addHookBefore('Users::save', 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->save(…) 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::save', 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.236