mc4wp_form_auto_scroll

Filters the `auto_scroll` setting for when a form is submitted.

Description

apply_filters( 'mc4wp_form_auto_scroll', (boolean|string) $auto_scroll ); 

Accepts the following values:

- false - default - animated

Parameters (1)

0. $auto_scroll (boolean|string)
The auto scroll.

Usage

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

Defined (1)

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

/includes/forms/class-asset-manager.php  
  1. $config['auto_scroll'] = apply_filters( 'mc4wp_form_auto_scroll', $auto_scroll );