Advanced Tools for Gravity Forms
The Advanced Tools for Gravity Forms plugin has some useful hooks for developers to use to further enhance its functionality.
gfadvtools_user_metakey_ignore_list
TYPE ⇢ Filter
This filter allows developers to modify or extend the list of user meta keys that should be ignored when retrieving available user meta keys for merge tags. You can add or remove specific keys from the list to suit your needs.
Example Usage
/**
* Modify the list of user meta keys to ignore.
*
* @param array $ignore_list The current list of meta keys to ignore.
*
* @return array The modified list of ignored meta keys.
*/
add_filter( 'gfadvtools_user_metakey_ignore_list', function( $ignore_list ) {
// Add a custom meta key to ignore
$ignore_list[] = 'some_custom_meta_key';
return $ignore_list;
} );gfadvtools_user_metakey_ignore_patterns
TYPE ⇢ Filter
This filter allows developers to modify the patterns used to match and exclude user meta keys based on their prefixes, suffixes, or substrings. You can use this filter to adjust the logic for which keys are excluded based on naming conventions.
Example Usage
/**
* Modify the user meta key ignore patterns.
*
* @param array $patterns The current ignore patterns for user meta keys.
*
* @return array The modified ignore patterns.
*/
add_filter( 'gfadvtools_user_metakey_ignore_patterns', function( $patterns ) {
// Add a pattern to ignore keys that start with "test_"
$patterns[ 'starts_with' ][] = 'test_';
// Add a pattern to ignore keys that end with "_demo"
$patterns[ 'ends_with' ][] = '_demo';
// Add a pattern to ignore keys that contain "temporary"
$patterns[ 'contains' ][] = 'temporary';
return $patterns;
} );gfadvtools_post_metakey_ignore_list
TYPE ⇢ Filter
This filter allows developers to specify a list of post meta keys that should be excluded from the list of available post meta fields. This is useful for removing irrelevant or sensitive keys from merge tag options or other data-driven interfaces that consume post meta.
Example Usage
/**
* Add custom post meta keys to the ignore list.
*
* @param array $ignore_list The current list of meta keys to ignore.
*
* @return array The modified list of meta keys to ignore.
*/
add_filter( 'gfadvtools_post_metakey_ignore_list', function( $ignore_list ) {
$ignore_list[] = '_my_custom_key';
return $ignore_list;
} );gfadvtools_post_metakey_ignore_patterns
TYPE ⇢ Filter
This filter allows developers to define pattern-based rules for ignoring post meta keys, including those that start with, end with, or contain specific strings. This is useful for dynamically excluding groups of meta keys without specifying every individual one.
Example Usage
/**
* Modify the post meta key ignore patterns.
*
* @param array $patterns The current ignore patterns for post meta keys.
*
* @return array The modified ignore patterns.
*/
add_filter( 'gfadvtools_post_metakey_ignore_patterns', function( $patterns ) {
// Ignore post meta keys starting with "custom_"
$patterns[ 'starts_with' ][] = 'custom_';
// Ignore post meta keys ending in "_meta"
$patterns[ 'ends_with' ][] = '_meta';
// Ignore post meta keys containing "legacy"
$patterns[ 'contains' ][] = 'legacy';
return $patterns;
} );gfadvtools_export_value
TYPE ⇢ Filter
This filter allows you to modify the final value used in exports or reports for a specific field and entry. It’s particularly useful for customizing output formats, replacing values, or adding conditional logic during data rendering.
Example Usage
/**
* Customize export value for specific fields.
*
* @param string $value The current value.
* @param int|string $field_id The field ID.
* @param array $entry The Gravity Forms entry.
* @param array $form The Gravity Forms form.
* @param bool $export Whether this is an export context.
*
* @return string Modified value.
*/
add_filter( 'gfadvtools_export_value', function( $value, $field_id, $entry, $form, $export ) {
if ( $field_id === 37 && $export ) {
return strtoupper( $value );
}
if ( $field_id === 'user_ip' ) {
return 'Redacted for privacy';
}
return $value;
}, 10, 5 );