$permissions->saveReady()

Hook called just before a Permission is saved

This public method is for hooks to monitor and may not be intended to be called directly.

Available since version 3.0.128.

Usage

// basic usage
$array = $permissions->saveReady(Page $page);

// usage with all arguments
$array = $permissions->saveReady(Page $page);

Arguments

NameType(s)Description
$pagePage

The page about to be saved

Return value

array

Optional extra data to add to pages save query.


Hooking saveReady(…)

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

$this->addHookBefore('Permissions::saveReady', 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 saveReady(…) 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::saveReady', 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.251