$roles->delete() method

Permanently delete a Role

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 = $roles->delete($page);

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

Arguments

Name	Type(s)	Description
`page`	Role, Page	Permission to delete
`recursive` (optional)	bool	If set to true, then this will attempt to delete any pages below the Permission too.

Return value

bool

True on success, false on failure

Exceptions

Method can throw exceptions on error:

WireException

Hooking $roles->delete(…)

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

$this->addHookBefore('Roles::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $roles = $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 $roles->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('Roles::delete', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $roles = $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;
});

$roles methods and properties

API reference based on ProcessWire core version 3.0.236