$roles->saveReady() method

Hook called just before a page of this type is saved

Available since version 3.0.128.

Usage

$array = $roles->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 $roles->saveReady(…)

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

$this->addHookBefore('Roles::saveReady', 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);

  /* 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 $roles->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('Roles::saveReady', 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);

  /* 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.248

Latest news

  • ProcessWire Weekly #575
    The 575th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 17 May 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer