$forms->render() method

Render a form directly (embed method C)

Usage

// basic usage
$formBuilderRender = $forms->render($form);

// usage with all arguments
$formBuilderRender = $forms->render($form, $vars = []);

Arguments

Name	Type(s)	Description
`form`	string, FormBuilderForm
`vars` (optional)	array, Page	Optional associative array of variable names to pre-populated values, or Page to pull them from. If providing a Page, then the form field names must match the Page field names.

Return value

FormBuilderRender

Exceptions

Method can throw exceptions on error:

FormBuilderException

Hooking $forms->render(…)

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

$this->addHookBefore('FormBuilder::render', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $forms = $event->object;

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $forms->render(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FormBuilder::render', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $forms = $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);
  $vars = $event->arguments(1);

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

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

$forms methods and properties

API reference based on ProcessWire core version 3.0.236