FormBuilderProcessor::emailFormResponder() method

Email the form result to the sender (auto-responder)

In this example, we have configured the auto-responder feature on the form’s actions tab, but rather than sending an auto-responder to everyone, we want to send it to just users that have clicked a “Yes” option on a field named send_me_an_email, which is a radios field having options “Yes” and “No”. In this hook, we check if the user as NOT clicked the “Yes” option, then we prevent the method we’ve hooked from being called by using $event->replace = true;

Example

// Example of conditional auto-responder
$forms->addHookBefore('FormBuilderProcessor::emailFormResponder', function($event) {
  $form = $event->arguments(0);
  $field = $form->getChildByName('send_me_an_email');
  if(!$field) return;
  if($field->attr('value') != 'Yes') {
    // tell PW not to call the method we hooked
    // which will prevent the auto-responder from sending
    $event->replace = true;
  }
});

Usage

$bool = $processor->emailFormResponder(InputfieldForm $form, array $data);

Arguments

NameType(s)Description
$formInputfieldForm
$dataarray

Return value

bool

False on fail, true on success, and 0.5.3+ int 1 on cancel, 0 if no email to send to

Hooking $processor→emailFormResponder(…)

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

$this->addHookBefore('FormBuilderProcessor::emailFormResponder', 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);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $processor->emailFormResponder(…) 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::emailFormResponder', 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);

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