Move a page to the trash
When a page is moved to the trash, it is in a "delete pending" state. Once trashed, the page can be either restored to its original location, or permanently deleted (when the trash is emptied).
Example
// Trash a product page
$product = $pages->get('/products/foo-bar-widget/');
$pages->trash($product); Usage
// basic usage
$bool = $pages->trash(Page $page);
// usage with all arguments
$bool = $pages->trash(Page $page, bool $save = true);Arguments
| Name | Type(s) | Description |
|---|---|---|
page | Page | Page to trash |
save (optional) | bool | Set to false if you will perform your own save() call afterwards to complete the operation. Omit otherwise. Primarily for internal use. |
Return value
boolReturns true on success, false on failure.
Exceptions
Method can throw exceptions on error:
WireException
Hooking $pages->trash(…)
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::trash', 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::trash', 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