Save only a field from the given page
This is the same as calling $page->save($field).
Example
// Update the summary field on $page and save it
$page->summary = "Those who know do not speak. Those who speak do not know.";
$pages->saveField($page, 'summary');Usage
// basic usage
$bool = $pages->saveField(Page $page, $field);
// usage with all arguments
$bool = $pages->saveField(Page $page, $field, $options = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
page | Page | Page to save |
field | string, Field | Field object or name (string) |
options (optional) | array, string | Optionally specify one or more of the following to modify default behavior:
|
Return value
boolTrue on success, false on failure
Exceptions
Method can throw exceptions on error:
WireException
Hooking $pages->saveField(…)
You can add your own hook events that are executed either before or after the $pages 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 method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('Pages::saveField', 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);
$field = $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, $field);
$event->arguments(2, $options);
});Hooking after
The 'after' hooks are called immediately after each $pages 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::saveField', 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);
$field = $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;
});See Also
API reference based on ProcessWire core version 3.0.236