gform_signature_show_in_all_fields

Description

The “gform_signature_show_in_all_fields” filter in the Gravity Forms Signature Add-On allows the inclusion of the signature image in the {all_fields} merge tag output to be toggled on/off. The default is true.

Usage

add_filter( 'gform_signature_show_in_all_fields', 'your_function_name', 10, 4 );

Parameters

  • $include_signature bool
    The current value that indicates whether the signature image should be included. The default is true.
  • $field Field Object
    The Field Object.
  • $options string
    The merge tag modifiers. e.g. “value,nohidden” would be the modifiers for {all_fields:value,nohidden}.
  • $value
    The value of the field currently being processed.

Examples

The example below turns off the inclusion of the signature image in the {all_fields} merge tag.

add_filter( 'gform_signature_show_in_all_fields', '__return_false' );

Placement

This code can be used in the functions.php file of the active theme, a custom functions plugin, a custom add-on, or with a code snippets plugin.

See also the PHP section in this article: Where Do I Put This Code?

Since

This filter was added in version 2.3.

Source Code

This filter is located in GFSignature::merge_tag_filter() in gravityformssignature/class-gf-signature.php.