$pages->saveFields() method

Save multiple named fields from given page

Available since version 3.0.242.

Example

// you can specify field names as array…
$a = $pages->saveFields($page, [ 'title', 'body', 'summary' ]);

// …or a CSV string of field names:
$a = $pages->saveFields($page, 'title, body, summary');

// return value is array of saved field/property names
print_r($a); // outputs: array( 'title', 'body', 'summary' )

Usage

// basic usage
$array = $pages->saveFields(Page $page, $fields);

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

Arguments

Name Type(s) Description

Name	Type(s)	Description
`page`	Page	Page to save
`fields`	array, string, string[], Field[]	Array of field names to save or CSV/space separated field names to save. These should only be Field names and not native page property names.
`options` (optional)	array	Optionally specify one or more of the following to modify default behavior: `quiet` (boolean): Specify true to bypass updating of modified user and time (default=false). `noHooks` (boolean): Prevent before/after save hooks (default=false), please also use $pages->___saveField() for call. See $options argument for Pages::save() for additional options

page

Page

Page to save

fields

array, string, string[], Field[]

Array of field names to save or CSV/space separated field names to save. These should only be Field names and not native page property names.

options (optional)

array

Optionally specify one or more of the following to modify default behavior:

quiet (boolean): Specify true to bypass updating of modified user and time (default=false).
noHooks (boolean): Prevent before/after save hooks (default=false), please also use $pages->___saveField() for call.
See $options argument for Pages::save() for additional options

Return value

array

Array of saved field names (may also include property names if they were modified)

Exceptions

Method can throw exceptions on error:

WireException

Hooking $pages->saveFields(…)

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

$this->addHookBefore('Pages::saveFields', 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);
  $fields = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $pages->saveFields(…) 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::saveFields', 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);
  $fields = $event->arguments(1);
  $options = $event->arguments(2);

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

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

$pages methods and properties

API reference based on ProcessWire core version 3.0.244