Hook called after a page has been sorted, or had its children re-sorted
Usage
// basic usage
$pages->sorted(Page $page);
// usage with all arguments
$pages->sorted(Page $page, bool $children = false, int $total = 0);Arguments
| Name | Type(s) | Description |
|---|---|---|
page | Page | Page given to have sort adjusted |
children (optional) | bool | If true, children of $page have been all been re-sorted |
total (optional) | int | Total number of pages that had sort adjusted as a result |
Hooking $pages->sorted(…)
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::sorted', 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);
$children = $event->arguments(1);
$total = $event->arguments(2);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
$event->arguments(1, $children);
$event->arguments(2, $total);
});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::sorted', 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);
$children = $event->arguments(1);
$total = $event->arguments(2);
/* 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.248