$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.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer