Restore a page in the trash back to its original location and state
If you want to restore the page to some location other than its original location, set the $page->parent property
of the page to contain the location you want it to restore to. Otherwise the page will restore to its original location,
when possible to do so.
Example
// Grab a page from the trash and restore it
$trashedPage = $pages->get(1234);
$pages->restore($trashedPage); Usage
// basic usage
$bool = $pages->restore(Page $page);
// usage with all arguments
$bool = $pages->restore(Page $page, bool $save = true);Arguments
| Name | Type(s) | Description |
|---|---|---|
page | Page | Page that is in the trash that you want to restore |
save (optional) | bool | Set to false if you only want to prep the page for restore (i.e. you will save the page yourself later). Primarily for internal use. |
Return value
boolTrue on success, false on failure.
Hooking $pages->restore(…)
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::restore', 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);
$save = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
$event->arguments(1, $save);
});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::restore', 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);
$save = $event->arguments(1);
/* 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