$page→saveReady()

Called right before this Page is saved

If the $name argument is populated then only that field/property will be saved. But if $name is false, then the whole page will be saved, including any changes in the $changes array, and any more you make when this method is called. This is different from the Pages::saveReady hookable method, which is only called when the entire page is saved.

Example

$wire->addHook('Page:saveReady', function($e) {
  $page = $e->object;
  $name = $e->arguments(1);
  if($name) {
    $e->message("Ready to save field $name on page $page");
  } else {
    $e->message("Ready to save page $page");
  }
});

Usage

// basic usage
$page->saveReady(array $changes);

// usage with all arguments
$page->saveReady(array $changes, $name = false);

Arguments

NameType(s)Description
$changesarray

Names of changed field names and/or properties

$name (optional)string false

Indicates whether entire page was saved or just a field/property:

  • Populated with string field or property name if $page->save($name) was used rather than $page->save();
  • Populated with false if entire page is to be saved, i.e. $page->save()

Hooking $page→saveReady(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $page->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('Page::saveReady', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $page = $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)
  $changes = $event->arguments(0);
  $name = $event->arguments(1);

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

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

$page methods and properties

API reference based on ProcessWire core version 3.0.252