$permissions->deleted() method

Hook called when a permission is deleted

Available since version 3.0.128.

Usage

$permissions->deleted(Page $page);

Arguments

NameType(s)Description
pagePage

Page that was deleted

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $permissions->deleted(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $permissions->deleted(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Permissions::deleted', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $permissions = $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);

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

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

$permissions methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #562
    In the 562nd issue of ProcessWire Weekly we're going to cover the latest core updates, introduce a very interesting triplet of newly released third party modules by Bernhard Baumrock, and more. Read on!
    Weekly.pw / 15 February 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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer