gpecf_field_total (JS)

1. Description
2. Usage
3. Parameters
4. Since
5. Example
   1. Add a Flat Rate of 5.5 to the Tax field with ID 4.

Description

Modify the calculation of the field total.

This filter must be used with its PHP counterpart to handle modifying the calculation of the field total on submission.

Usage

gform.addFilter( 'gpecf_field_total', 'my_custom_function' );

Since

This filter is available since GP eCommerce Fields 1.2.18.

Example

Add a Flat Rate of 5.5 to the Tax field with ID 4.

gform.addFilter( 'gpecf_field_total', function ( fieldTotal, args ) {
	// Update '4' to the Id of the Tax field.
	if ( args['fieldId'] == 4 ){
		fieldTotal = fieldTotal + 5.5;
	}
	return fieldTotal;
} );