$users->save() method

Save a page object and its fields to database.

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

Usage

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

Arguments

NameType(s)Description
pagePage

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.155

Twitter updates

  • ProcessWire 3.0.156 core updates— More
    15 May 2020
  • This post covers a few of the bigger updates in ProcessWire 3.0.154+3.0.155. This includes new live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our input->urlSegment() method! More
    24 April 2020
  • A brief look at what's new in ProcessWire 3.0.154 in this forum post: More
    17 April 2020

Latest news

  • ProcessWire Weekly #314
    In the 314th issue of ProcessWire Weekly we're going to cover the latest core updates, check out a new module called Fieldtype Color Options, and more. Read on!
    Weekly.pw / 16 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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK