FormBuilderProcessor::emailForm() method

Email the form result to the administrator(s)

Usage

// basic usage
$bool = $formBuilderProcessor->emailForm(InputfieldForm $form, array $data);

// usage with all arguments
$bool = $formBuilderProcessor->emailForm(InputfieldForm $form, array $data, string $emailTo = '');

Arguments

Name	Type(s)	Description
`form`	InputfieldForm
`data`	array	Entry data
`emailTo` (optional)	string	Alternate "to" email address, if something different than what’s defined in form settings.

Return value

bool int

False if there was a failed send, and true if successful or 0.5.3+ integer 1 if cancelled, 0 if no email to send to

Hooking FormBuilderProcessor::emailForm(…)

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

$this->addHookBefore('FormBuilderProcessor::emailForm', 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);
  $data = $event->arguments(1);
  $emailTo = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each FormBuilderProcessor::emailForm(…) 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::emailForm', 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);
  $data = $event->arguments(1);
  $emailTo = $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.248