Hook called after a page is successfully saved
This is the same as hooking after Pages::save, except that it occurs before other save-related hooks.
Whereas Pages::save hooks occur after. In most cases, the distinction does not matter.
Usage
// basic usage
$pages->saved(Page $page);
// usage with all arguments
$pages->saved(Page $page, array $changes = [], array $values = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
page | Page | The page that was saved |
changes (optional) | array | Array of field names that changed |
values (optional) | array | Array of values that changed, if values were being recorded, see Wire::getChanges(true) for details. |
Hooking $pages->saved(…)
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::saved', 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);
$changes = $event->arguments(1);
$values = $event->arguments(2);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
$event->arguments(1, $changes);
$event->arguments(2, $values);
});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::saved', 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);
$changes = $event->arguments(1);
$values = $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.214