mc4wp_form_api_error

Fire action hook so API errors can be hooked into.

Description

do_action( 'mc4wp_form_api_error', (MC4WP_Form) $form, (string) $error_message ); 

Parameters (2)

0. $form (MC4WP_Form)
The form.
1. $error_message (string)
The error message.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'mc4wp_form_api_error', $form, $error_message ); 
The following example is for adding a hook callback.
  1. // define the mc4wp_form_api_error callback 
  2. function action_mc4wp_form_api_error( $form, $error_message ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'mc4wp_form_api_error', 'action_mc4wp_form_api_error', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'mc4wp_form_api_error', 'action_mc4wp_form_api_error', 10, 2 ); 

Defined (1)

The action is defined in the following location(s).

/includes/forms/class-form-listener.php  
  1. do_action( 'mc4wp_form_api_error', $form, $error_message );