Hook called when a page has been renamed (i.e. had its name field change)
The previous name can be accessed at $page->namePrevious. The new name can be accessed at $page->name.
This hook is only called when a page's name changes. It is not called when a page is moved unless the name was changed at the same time.
Multi-language note:
Also note this hook may be called if a page's multi-language name changes.
In those cases the language-specific name is stored in "name123" while the
previous value is stored in "-name123" (where 123 is the language ID).
Usage
$pages->renamed(Page $page);Arguments
| Name | Type(s) | Description |
|---|---|---|
page | Page | The $page that was renamed |
Hooking $pages->renamed(…)
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::renamed', 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);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
});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::renamed', 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);
/* 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