FormBuilderProcessor::renderReady() method

Hook called right before form is rendered, and it returns the rendered form output

Hook before this method to modify anything in the $form, such as populating field values.
Hook after this method to directly modify the returned form output HTML.

As an example, you might hook this method to pre-populate values for a form. In this example below, if a user is logged in, we'll pre-populate their email address in the appropriate field named "email":

Example

$forms->addHookBefore('FormBuilderProcessor::renderReady', function($event) {
  $form = $event->arguments(0);
  $user = $event->wire('user');
  if(!$user->isLoggedIn()) return; // if not logged in, exit now
  // see if there a field in the form named 'email'
  $inputfield = $form->getChildByName('email');
  // if there is an email field and it's empty, populate user's email
  if($inputfield && $inputfield->isEmpty()) {
    $inputfield->attr('value', $user->email);
  }
});

Usage

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

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

Arguments

Name	Type(s)	Description
`$form`	`InputfieldForm`	Form to render
`$formFile` (optional)	`string`	File to use to render form, only present for embed method D.
`$vars` (optional)	`array`	Variables to provide to $formFile, only present for embed method D

Return value

string

Hooking $processor→renderReady(…)

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

$processor methods and properties

API reference based on ProcessWire core version 3.0.252