$pages->save() method

Save a page object and its fields to database.

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

Example

// Modify a page and save it
$p = $pages->get('/festivals/decatur/beer/');
$p->of(false); // turn off output formatting, if it's on
$p->title = "Decatur Beer Festival";
$p->summary = "Come and enjoy fine beer and good company at the Decatur Beer Festival.";
$pages->save($p); 

Usage

// basic usage
$bool = $pages->save(Page $page);

// usage with all arguments
$bool = $pages->save(Page $page, array $options = []);

Arguments

NameType(s)Description
pagePage

Page object to save

options (optional)array

Optional array to modify default behavior, with one or more of the following:

  • uncacheAll (boolean): Whether the memory cache should be cleared (default=true).
  • resetTrackChanges (boolean): Whether the page's change tracking should be reset (default=true).
  • quiet (boolean): When true, modified date and modified_users_id won't be updated (default=false).
  • adjustName (boolean): Adjust page name to ensure it is unique within its parent (default=false).
  • forceID (integer): Use this ID instead of an auto-assigned one (new page) or current ID (existing page).
  • ignoreFamily (boolean): Bypass check of allowed family/parent settings when saving (default=false).
  • noHooks (boolean): Prevent before/after save hooks (default=false), please also use $pages->___save() for call.
  • noFields (boolean): Bypass saving of custom fields, leaving only native properties to be saved (default=false).

Return value

bool

True on success, false on failure

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $pages->save(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $options);
});

Hooking after

The 'after' hooks are called immediately after each $pages->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('Pages::save', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $pages = $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);
  $options = $event->arguments(1);

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

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

See Also


$pages methods and properties

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • ProcessWire 3.0.142 has a lot of updates but the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look at that, and also outline all of the new features in the just-released FormBuilder v40— More
    11 October 2019
  • This week’s dev branch version brings you improvements to ProcessWire’s input->cookie API variable, plus it adds the ability to modify system URLs and paths at runtime. This post also includes some examples to demonstrate just how useful this can be— More
    20 September 2019
  • New post: This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140— More
    6 September 2019

Latest news

  • ProcessWire Weekly #284
    In the 284th issue of ProcessWire Weekly we're going to take a quick look at the latest core updates, introduce a new module called InputfieldFloatRange, and continue our ongoing poll series #processwireworks. Read on!
    Weekly.pw / 20 October 2019
  • ProcessWire 3.0.142 core updates
    This latest version of the core on the dev branch has a lot of updates, and the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look and also outline all of the new features in the just-released FormBuilder v40.
    Blog / 11 October 2019
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer