mc4wp_form_errors

Filters whether this form has errors.

Description

apply_filters( 'mc4wp_form_errors', (array) $errors, (MC4WP_Form) $form ); 

Runs only when a form is submitted. Expects an array of message keys with an error type (string).

Beware: all non-string values added to this array will be filtered out.

Parameters (2)

0. $errors (array)
The errors.
1. $form (MC4WP_Form)
The form.

Usage

To run the hook, copy the example below.
  1. $errors = apply_filters( 'mc4wp_form_errors', $errors, $form ); 
  2.  
  3. if ( !empty( $errors ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the mc4wp_form_errors callback 
  2. function filter_mc4wp_form_errors( $errors, $form ) { 
  3. // make filter magic happen here... 
  4. return $errors
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'mc4wp_form_errors', 'filter_mc4wp_form_errors', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'mc4wp_form_errors', 'filter_mc4wp_form_errors', 10, 2 ); 

Defined (1)

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

/includes/forms/class-form.php  
  1. $errors = (array) apply_filters( 'mc4wp_form_errors', $errors, $form );