mc4wp_form_error_<error>

Fires right after a form was submitted with errors.

Description

do_action( 'mc4wp_form_error_<error>', (MC4WP_Form) $form ); 

The dynamic portion(s) of the hook refer to the error that occurred.

Default errors give us the following possible hooks:

- mc4wp_form_error_error General errors - mc4wp_form_error_spam - mc4wp_form_error_invalid_email Invalid email address - mc4wp_form_error_already_subscribed Email is already on selected list(s) - mc4wp_form_error_required_field_missing One or more required fields are missing - mc4wp_form_error_no_lists_selected No MailChimp lists were selected

Parameters (1)

0. $form (MC4WP_Form)
The form instance of the submitted form.

Usage

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

Defined (1)

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

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