gplcb_checkbox_count (JS)

  1. Description
  2. Usage
  3. Parameters
  4. Example
    1. Custom Choice Counts
  5. Since

Description

Filter the count value of each checkbox in a field.

Useful when trying to specify a custom weighted value for some checkboxes.

Usage

gform.addFilter( 'gplcb_checkbox_count', 'myCustomFunction' );

Parameters

  • value number

    Value of the current choice, default 1.

  • formId number

    The ID of the current form.

  • fieldId number

    The ID of the current Checkbox field.

  • choice number

    The sequence number of the current Checkbox (starts from 1).

Example

Custom Choice Counts

This example adjusts changes the weight of the second and the fourth checkboxes, making each count as 2 checkboxes instead of 1.

window.gform.addFilter( 'gplcb_checkbox_count', function( value, formId, fieldId, choice ) {
        // Only change the count for choices in field ID 2 in form ID 1.
	if ( formId === 1 && fieldId === 2 ) {
		// An if statement or a switch statement can be used here
		// to target the specific choices that should count as 2
		if ( choice === 2 || choice === 4 ) {
			value = 2;
		}
	}
	
	return value;
} );

Since

This filter is available since Gravity Forms Limit Checkboxes 1.3.1.