Skip to main content

Filter: gform_ability_hidden_field_ids

Filters the field IDs hidden from the entry read abilities.

Hidden fields are redacted from entries-get and entries-search responses (including their sub-inputs), and search or sort criteria referencing them are rejected so values cannot be inferred.

Parameters​

NameTypeDescription
$field_idsstring[]Field IDs to hide. A whole-field ID ('4') also hides its sub-inputs ('4.3'); an input ID ('7.1') hides only that input.
$form_idintThe form ID the entry or search targets.

Example​

// Hide fields flagged for personal-data erasure from agents:
add_filter( 'gform_ability_hidden_field_ids', function ( $ids, $form_id ) {
    $form = GFAPI::get_form( $form_id );
    foreach ( (array) rgar( $form, 'fields' ) as $field ) {
        if ( ! empty( $field->personalDataErase ) ) {
            $ids[] = (string) $field->id;
        }
    }
    return $ids;
}, 10, 2 );

Since​

  • 3.1.0

Source​

Defined in includes/abilities/handlers/class-gf-abilities-handler-entries.php at line 546