FormBuilderProcessor::renderReady() method

Hook called for render ready, returns the output of $form->render();

NOTE: the $formFile and $vars arguments are only populated when using embed method D (custom form file).

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

Internal usage

// basic internal usage
$string = $this->renderReady(InputfieldForm $form);

// internal usage with all arguments
$string = $this->renderReady(InputfieldForm $form, string $formFile = '', array $vars = []);

Arguments

Name	Type(s)	Description
`$form`	`InputfieldForm`
`$formFile` (optional)	`string`	Only present in embed method D
`$vars` (optional)	`array`	Only present in embed method D

Return value

string

Hooking $this→renderReady(…)

You can add your own hook events that are executed either before or after the $this->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 $this->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;

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $this->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;

  // Get values of arguments sent to hook (if needed)
  $form = $event->arguments(0);
  $formFile = $event->arguments(1);
  $vars = $event->arguments(2);

  /* 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.251