$users->delete() method

Permanently delete a page and its fields.

Unlike $pages->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 be thrown.

Hook note:
If you want to hook this method, please hook the deleteReady, deleted, or Pages::delete method instead, as hooking this method will not hook relevant pages deleted directly through $pages->delete().

Usage

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

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

Arguments

Name	Type(s)	Description
`page`	Page
`recursive` (optional)	bool	If set to true, then this will attempt to delete all children too.

Return value

bool

Exceptions

Method can throw exceptions on error:

WireException

Hooking $users->delete(…)

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

$this->addHookBefore('Users::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $users = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $recursive = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $users->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('Users::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $users = $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);

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

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

$users methods and properties

API reference based on ProcessWire core version 3.0.236