FormBuilderProcessor::formSubmitInvalid() method

Called when an invalid form submission is received that prevented it from being processed

Invalid submit key received, like from previously cached form or CSRF.
User receives error message that says "Invalid form submission".
Note that the formSubmitError() method is not called since form did not reach processing state.
Form has not been processed and will not be. Submitted input can only be retrieved from POST vars directly at this point.

This protected method is for hooks to monitor and it is likely not intended to be called directly.

Available since version 0.4.5.

Internal usage

$processor->formSubmitInvalid(InputfieldForm $form, array $errors);

Arguments

Name	Type(s)	Description
`$form`	`InputfieldForm`	The form that was not processed.
`$errors`	`array`	Note these errors are for admin eyes only, it has details about what was missing from submit key.

Hooking $processor→formSubmitInvalid(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $processor->formSubmitInvalid(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

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

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

$processor methods and properties

API reference based on ProcessWire core version 3.0.252