FormBuilderProcessor::savePageDone() method
Hook called right after a page is saved
Usage
$array = $processor->savePageDone(Page $page, array $data, bool $isNew, $onlyFields);
Arguments
Name | Type(s) | Description |
---|---|---|
$page | Page | Page that was saved |
$data | array | Entry data that was populated to page |
$isNew | bool | Was it a new page before it was saved? |
$onlyFields | null array | Saved field names present in this array. If omitted, all mapped field names were saved. Names are form field names. |
Return value
array
Return entry data (probably not useful)
Hooking $processor→savePageDone(…)
You can add your own hook events that are executed either before or after the $processor->savePageDone(…)
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 $processor->savePageDone(…)
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FormBuilderProcessor::savePageDone', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FormBuilderProcessor = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$page = $event->arguments(0);
$data = $event->arguments(1);
$isNew = $event->arguments(2);
$onlyFields = $event->arguments(3);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
$event->arguments(1, $data);
$event->arguments(2, $isNew);
$event->arguments(3, $onlyFields);
});
Hooking after
The 'after' hooks are called immediately after each $processor->savePageDone(…)
method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('FormBuilderProcessor::savePageDone', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FormBuilderProcessor = $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);
$data = $event->arguments(1);
$isNew = $event->arguments(2);
$onlyFields = $event->arguments(3);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});
$processor methods and properties
API reference based on ProcessWire core version 3.0.251