gppa_skip_field_value_during_hydration
Description
Filter whether a field’s value should be skipped during hydration. This can be useful in situations
such as excluding hidden fields from being displayed in the @{order_summary} merge tag output when
populated using a Live Merge Tag.
Usage
Filter whether all field values should be skipped during hydration.
add_filter( 'gppa_skip_field_value_during_hydration', '__return_true' );Filter whether all field values in a form should be skipped during hydration.
add_filter( 'gppa_skip_field_value_during_hydration_FORMID', '__return_true' );Filter whether a specific field’s value in a form should be skipped during hydration.
add_filter( 'gppa_skip_field_value_during_hydration_FORMID_FIELDID', '__return_true' );Parameters
skip bool
Whether to skip the field value during hydration.
form array
The form currently being processed.
field \GF_Field
The field currently being processed.
field_values array
The field values currently being processed.
Examples
Skip hydrating the values of conditionally hidden fields.
This example prevents conditionally hidden product option fields from showing in {order_summary} when used as a Live Merge Tag.
add_filter( 'gppa_skip_field_value_during_hydration', function ( $skip, $form, $field, $field_values, $entry = array() ) {
if ( GFFormsModel::is_field_hidden( $form, $field, $field_values, $entry ) ) {
return true;
}
return $skip;
}, 10, 4 );Since
This filter is available since Gravity Forms Populate Anything 1.2.46.
Added $entry parameter in Populate Anything 1.2.51.