$permissionssaved()

Hook called when a permission is saved

Usage

// basic usage
$permissions->saved(Page $page);
// usage with all arguments
$permissions->saved(Page $page, array $changes = [], array $values = []);

Arguments

NameType(s)Description
$pagePage

Page that was saved

$changes (optional)array

Array of changed field names

$values (optional)array

Array of changed field values indexed by name (when enabled)

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $permissions→saved(...)

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

$this->addHookBefore('Permissions::saved', 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);
 $changes = $event->arguments(1);
 $values = $event->arguments(2);
 /* Your code here, perhaps modifying arguments */
 // Populate back arguments (if you have modified them)
 $event->arguments(0, $page);
 $event->arguments(1, $changes);
 $event->arguments(2, $values);
});

Hooking after

The 'after' hooks are called immediately after each $permissions->saved(...) 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::saved', 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);
 $changes = $event->arguments(1);
 $values = $event->arguments(2);
 /* 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.267

AltStyle によって変換されたページ (->オリジナル) /