mc4wp_form_required_fields

Filters the required fields for a form.

Description

apply_filters( 'mc4wp_form_required_fields', (array) $required_fields, (MC4WP_Form) $form ); 

By default, this holds the following fields.

- All fields which are required for the selected MailChimp lists - All fields in the form with a required attribute.

Parameters (2)

0. $required_fields (array)
The required fields.
1. $form (MC4WP_Form)
The form.

Usage

To run the hook, copy the example below.
  1. $required_fields = apply_filters( 'mc4wp_form_required_fields', $required_fields, $form ); 
  2.  
  3. if ( !empty( $required_fields ) ) { 
  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_required_fields callback 
  2. function filter_mc4wp_form_required_fields( $required_fields, $form ) { 
  3. // make filter magic happen here... 
  4. return $required_fields
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'mc4wp_form_required_fields', 'filter_mc4wp_form_required_fields', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'mc4wp_form_required_fields', 'filter_mc4wp_form_required_fields', 10, 2 ); 

Defined (1)

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

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