InputfieldForm::process() method

Process the form

Optionally use this rather than processInput() for processing forms.
Returns true on processing success or false if processed with errors.
Use the getErrors() method to retrieve errors.

Available since version 3.0.205.

Example

if($form->process()) {
  // form processed successfully without errors
} else {
  $errors = $form->getErrors(); // array of error messages…
  $inputs = $form->getErrorInputfields(); // …or array of Inputfields with errors
}

Usage

$bool = $inputfieldForm->process();

Return value

bool

Exceptions

Method can throw exceptions on error:

WireException

Hooking InputfieldForm::process()

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

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

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

$this->addHookAfter('InputfieldForm::process', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $InputfieldForm = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

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

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

InputfieldForm methods and properties

API reference based on ProcessWire core version 3.0.248