$page->delete() method

Delete this page from the database

This is the same as calling $pages->delete($page).

Examples

// Delete pages named "delete-me" that don't have children
$items = $pages->find("name=delete-me, numChildren=0");
foreach($items as $item) {
  $item->delete();
}
// Delete a page and recursively all of its children, grandchildren, etc. 
$item = $pages->get('/some-page/');
$item->delete(true);

Usage

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

// usage with all arguments
$bool = $page->delete(bool $recursive = false);

Arguments

NameType(s)Description
recursive (optional)bool

If set to true, then this will attempt to delete all children too.

Return value

bool int

True on success, false on failure, or int quantity of pages deleted when recursive option is true.

Exceptions

Method can throw exceptions on error:

  • WireException - when attempting to delete a page with children and $recursive option is not specified.

See Also


$page methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #557
    In the 557th issue of ProcessWire Weekly we're going to share the latest core development news, introduce a new third party module, and more. Read on!
    Weekly.pw / 12 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK