FormBuilderProcessor::renderError() method
Render an error message into markup
This protected method is for hooks to monitor and it is likely not intended to be called directly.
Internal usage
// basic internal usage
$string = $processor->renderError(string $error);
// internal usage with all arguments
$string = $processor->renderError(string $error, string $errorTemplate = '');
Arguments
Name | Type(s) | Description |
---|---|---|
$error | string | Error message to render |
$errorTemplate (optional) | string | Markup template for error, has {out} where error message is inserted. Omit to use module setting. |
Return value
string
Hooking $processor→renderError(…)
You can add your own hook events that are executed either before or after the $processor->renderError(…)
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->renderError(…)
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FormBuilderProcessor::renderError', 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)
$error = $event->arguments(0);
$errorTemplate = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $error);
$event->arguments(1, $errorTemplate);
});
Hooking after
The 'after' hooks are called immediately after each $processor->renderError(…)
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::renderError', 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)
$error = $event->arguments(0);
$errorTemplate = $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.251