) Called when ready to render, and returns rendered output. Note the $formFile and $vars arguments are only populated in embed method D.
) Called when ready to render, and returns rendered output. Note the $formFile and $vars arguments are only populated in embed method D.
Usage
// basic usage
// usage with all arguments
Return value
string
Hooking renderReady(…)
You can add your own hook events that are executed either before or after the renderReady(…)
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 renderReady(…)
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FormBuilderProcessor::renderReady', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FormBuilderProcessor = $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 renderReady(…)
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::renderReady', 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;
/* 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