Skip to main content
Version: v6

gfpdf_settings_sanitize

Description​

Gravity PDF does standard sanitisation of form fields but you might like to include your own special processing for any global PDF fields you add.

You can also use the gfpdf_settings_sanitize_$type filter, where $type refers to the field type – checkbox, select, ect.

Parameters​

$value | mixed​

  • The new value of the current field being processed

$key | string​

  • The ID of the field currently being processed

$input | array​

  • An array containing all the current fields that should be updated

$field | mixed​

  • The settings for the current field being processed

Usage​

This snippet shows you how to correctly sanitise your custom Gravity PDF field:

add_action( 'gfpdf_settings_sanitize', function( $value, $key, $input, $field ) {

    /* Check if it's our custom field and return a blank array if the variable type isn't currently an array */
    if( 'prefix_custom_field' === $key ) {
        if( ! is_array( $value ) ) {
            return array();
        }
    }

    return $value;

}, 10, 4 );

You can also target your field directly using the field ID:

add_action( 'gfpdf_settings_sanitize_prefix_custom_field', function( $value, $key, $input, $field ) {   
    if( ! is_array( $value ) ) {
        return array();
    }   

    return $value;
}, 10, 4 );

Source Code​

This filter is located in the Helper_Abstract_Options::settings_sanitize() method of /src/helper/abstract/Helper_Abstract_Options.php.