Hook called before a branch of pages is about to be deleted, called on root page of branch only
Note: this is called only on deletions that had 'recursive' option true and 1+ children.
Available since version 3.0.163.
Usage
$pages->deleteBranchReady(Page $page, array $options);
Arguments
Name | Type(s) | Description |
---|---|---|
page | Page | Page that was deleted |
options | array | Options passed to delete method |
Hooking $pages->deleteBranchReady(…)
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::deleteBranchReady', 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
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::deleteBranchReady', 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;
});
API reference based on ProcessWire core version 3.0.236