$pages->delete() method

Permanently delete a page, its fields and assets.

Unlike trash(), pages deleted here are not restorable. If you attempt to delete a page with children, and don't specifically set the $recursive argument to true, then this method will throw an exception. If a recursive delete fails for any reason, an exception will also will be thrown.

Example

// Delete a product page
$product = $pages->get('/products/foo-bar-widget/');
$pages->delete($product); 

Usage

// basic usage
$bool = $pages->delete(Page $page);

// usage with all arguments
$bool = $pages->delete(Page $page, $recursive = false, array $options = []);

Arguments

NameType(s)Description
pagePage

Page to delete

recursive (optional)bool, array

If set to true, then this will attempt to delete all children too. If you don't need this argument, optionally provide $options array instead.

options (optional)array

Optional settings to change behavior:

  • uncacheAll (bool): Whether to clear memory cache after delete (default=false)
  • recursive (bool): Same as $recursive argument, may be specified in $options array if preferred.

Return value

bool int

Returns true (success), or integer of quantity deleted if recursive mode requested.

Exceptions

Method can throw exceptions on error:

  • WireException - on fatal error


Hooking $pages->delete(…)

You can add your own hook events that are executed either before or after the $pages->delete(…) 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->delete(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Pages::delete', 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);
  $recursive = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $recursive);
  $event->arguments(2, $options);
});

Hooking after

The 'after' hooks are called immediately after each $pages->delete(…) 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::delete', 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);
  $recursive = $event->arguments(1);
  $options = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

See Also


$pages methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019
  • New post: This week we look at the latest version of ProcessWire, 3.0.127 with nearly 30 new commits resolving dozens of older issue reports and a couple useful new features— More
    1 March 2019

Latest news

  • ProcessWire Weekly #257
    In the 257th issue of ProcessWire Weekly we'll walk you through the new features in ProcessWire 3.0.130, introduce two new third party modules, and showcase the elegant new website of the QFMA. Read on!
    Weekly.pw / 13 April 2019
  • ProcessWire 3.0.130 core updates
    This week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each.
    Blog / 12 April 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer