ProcessPageEdit::ajaxSaveDone() method

Ajax save done - send output

When a hook overrides this, it should hook after and set $event->return = true; to indicate that it has handled the output.

Available since version 3.0.188.

Example

$wire->addHookAfter('ProcessPageEdit::ajaxSaveDone', function($event) {
  if($event->return === true) return; // another hook already handled output
  $page = $event->arguments(0); // Page
  $data = $event->arguments(1); // array
  $data['page'] = $page->id;
  header('Content-Type', 'application/json');
  echo json_encode($data);
  $event->return = true; // tell ProcessPageEdit we handled output
}); 

Usage

$bool = $processPageEdit->ajaxSaveDone(Page $page, array $data);

Arguments

NameType(s)Description
pagePage
dataarray

Return value

bool

Return true if hook has handled output, false if not (default)


Hooking ProcessPageEdit::ajaxSaveDone(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each ProcessPageEdit::ajaxSaveDone(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProcessPageEdit::ajaxSaveDone', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessPageEdit = $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);
  $data = $event->arguments(1);

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

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

ProcessPageEdit methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • Weekly update: Smooth rollout for ProcessWire 3.0.200 main/master, plus getting started on a new WP-to-PW site conversion and why they can be so rewarding— More
    20 May 2022
  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022

Latest news

  • ProcessWire Weekly #419
    In issue 419 of ProcessWire Weekly we'll check out this week's core updates, introduce a brand new recipe of the week, and more. Read on!
    Weekly.pw / 21 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • 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