gppt_auto_progress_support_conditions

1. Description
2. Usage
3. Parameters
4. Examples
   1. Enable Custom Pagination Support
5. Source Code
6. Since

Description

Filter the conditions that dictate whether or not a field supports auto-progression.

Usage

add_filter( 'gppt_auto_progress_support_conditions', 'your_function_name' );

Parameters

• $conditions array [{

  Set to true to enable custom pagination support.

  • type string

    A field or input type.

  • callback mixed

    A callable function (provided as a string or array) that will be passed a $field object and should return true if field types custom requirements for auto-progression are met. If not, return false.

    Here is an example from GP Page Transitions which requires that the Input Mask feature is enabled for Single Line Text fields to enable auto-progression support.

    array(
    	'type' => 'text',
    	'callback' => array( $this, 'auto_progress_condition_text' ),
    )

    public function auto_progress_condition_text( $field ) {
    	return $field['inputMask'] == true;
    }

  }]

Examples

Enable Custom Pagination Support

add_filter( 'gppt_auto_progress_support_conditions', 'add_custom_auto_progress_condition' );
function add_custom_auto_progress_condition( $conditions ) {
	$conditions[] = array(
		'type'     => 'my_custom_field_type',
		'callback' => 'my_custom_field_callback_func'
	);
	return $conditions;
}

function my_custom_field_callback_func( $field ) {
	return $field->someFeature == true;
}

Source Code

This filter is located in GP_Page_Transitions::get_auto_progress_support_conditions() in class-gp-page-transitions.php.

Since

This filter is available since GP Page Transitions 1.0.