FormBuilderProcessor::renderErrors() method

Render the given error messages for output

Available since version 0.4.0. went from protected to public

Usage

// basic usage
$string = $formBuilderProcessor->renderErrors();

// usage with all arguments
$string = $formBuilderProcessor->renderErrors($errors = [], bool $clear = false);

Arguments

Name	Type(s)	Description
`errors` (optional)	array, bool	Errors to render (default=auto detect), or specify true for $clear argument
`clear` (optional)	bool	Clear internal errors after rendering? (default=false) Added 0.4.5

Return value

string

Hooking FormBuilderProcessor::renderErrors(…)

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

$this->addHookBefore('FormBuilderProcessor::renderErrors', 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)
  $errors = $event->arguments(0);
  $clear = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each FormBuilderProcessor::renderErrors(…) 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::renderErrors', 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)
  $errors = $event->arguments(0);
  $clear = $event->arguments(1);

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

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

FormBuilderProcessor methods and properties

API reference based on ProcessWire core version 3.0.236