ProcessPageEdit::processSubmitAction() method

Process the given submit action value

Available since version 3.0.142.

Usage

$bool = $processPageEdit->processSubmitAction(string $value);

Arguments

NameType(s)Description
valuestring

Value of selected action, i.e. 'exit', 'view', 'add', next', etc.

Return value

bool

Returns true if value was acted upon or false if not


Hooking ProcessPageEdit::processSubmitAction(…)

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

$this->addHookBefore('ProcessPageEdit::processSubmitAction', 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)
  $value = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each ProcessPageEdit::processSubmitAction(…) 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::processSubmitAction', 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)
  $value = $event->arguments(0);

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

Latest news

  • ProcessWire Weekly #557
    In the 557th issue of ProcessWire Weekly we're going to share the latest core development news, introduce a new third party module, and more. Read on!
    Weekly.pw / 12 January 2025
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

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