$forms->load() method

Retrieve a form by $id, $name or specify boolean true to return all forms

Usage

$formBuilderForm = $forms->load($id);

Arguments

Name	Type(s)	Description
`id`

Return value

FormBuilderForm array null

Returns $form (or array of forms) on success, or NULL on failure to load form

Hooking $forms->load(…)

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

$this->addHookBefore('FormBuilder::load', 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)
  $id = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $forms->load(…) 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::load', 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)
  $id = $event->arguments(0);

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