{"id":9921,"date":"2015-12-23T15:05:38","date_gmt":"2015-12-23T20:05:38","guid":{"rendered":"https:\/\/docs.gravityforms.com\/?post_type=gdoc&p=9921"},"modified":"2025-04-18T11:22:08","modified_gmt":"2025-04-18T15:22:08","slug":"gform_addon_field_value","status":"publish","type":"post","link":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/","title":{"rendered":"gform_addon_field_value"},"content":{"rendered":"\n

Description<\/h2>\n\n\n\n

This filter can be used to modify a value before it is sent to a third-party by one of the Add-On Framework<\/a> based add-ons. If you want to filter the value for a specific add-on you can use gform_short_slug_field_value<\/a>.<\/p>\n\n\n\n

Usage<\/h2>\n\n\n\n

The base filter which would run for all forms and all fields would be used like so:<\/p>\n\n\n

\nadd_filter( 'gform_addon_field_value', 'your_function_name', 10, 5 )\n<\/pre><\/div>\n\n\n
To target a specific form append the form id to the hook name. (format: gform_addon_field_value_FORMID)<\/p>\n\n\n
\n\tadd_filter( 'gform_addon_field_value_10', 'your_function_name', 10, 5 );\n<\/pre><\/div>\n\n\n
To target a specific field append both the form id and the field id to the hook name. (format: gform_addon_field_value_FORMID_FIELDID)<\/p>\n\n\n
\nadd_filter( 'gform_addon_field_value_10_3', 'your_function_name', 10, 5 );\n<\/pre><\/div>\n\n\n
Parameters<\/h2>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
$field_value<\/strong><\/td>mixed<\/td>The current value of the field before being filtered.<\/td><\/tr>
$form<\/strong><\/td>Form Object<\/a><\/td>The form currently being processed.<\/td><\/tr>
$entry<\/strong><\/td>Entry Object<\/a><\/td>The entry currently being processed.<\/td><\/tr>
$field_id<\/strong><\/td>string<\/a><\/td>The ID of the field being processed.<\/td><\/tr>
$slug<\/strong><\/td>string<\/a><\/td>The add-on slug, used to namespace the filter hook.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/h2>\n\n\n\n
1. Change Value of Specific Field<\/h3>\n\n\n\n
This example shows how you can change the value of field 3 on form 10 before it is passed to any of the feed add-ons.<\/p>\n\n\n
\nadd_filter( 'gform_addon_field_value_10_3', function ( $field_value, $form, $entry, $field_id ) {\n    return 'your new value';\n}, 10, 4 );\n<\/pre><\/div>\n\n\n
2. Use Choice Text Instead of Value<\/h3>\n\n\n\n
This example shows how you can replace the value of a choice based survey field with the choice text.<\/p>\n\n\n
\nadd_filter( 'gform_addon_field_value', 'gf_get_choice_text', 10, 5 );\nfunction gf_get_choice_text( $field_value, $form, $entry, $field_id, $slug ) {\n    $field = RGFormsModel::get_field( $form, $field_id );\n\n    if ( is_object( $field ) && $field->type == 'survey' ) {\n        $field_value = $field->get_value_export( $entry, $field_id, true );\n    }\n\n    return $field_value;\n}\n<\/pre><\/div>\n\n\n
Placement<\/h2>\n\n\n\n
This code can be used in the functions.php<\/a> file of the active theme, a custom functions plugin, a custom add-on, or with a code snippets plugin.<\/p>\n\n\n\n
See also the PHP section in this article: Where Do I Put This Code?<\/a><\/p>\n\n\n\n
Source Code<\/h2>\n\n\n
\n$field_value = gf_apply_filters( array( 'gform_addon_field_value', $form['id'], $field_id ), $field_value, $form, $entry, $field_id, $this->_slug );\n<\/pre><\/div>\n\n\n
This filter is located in GFAddOn::get_field_value() in includes\/addon\/class-gf-addon.php<\/em>.<\/p>\n\n\n\n
Since<\/h2>\n\n\n\n
This filter was added in Gravity Forms 1.9.15.12.<\/p>\n","protected":false},"excerpt":{"rendered":"
This filter can be used to modify a value before it is sent to a third-party by one of the Add-On Framework based add-ons.<\/p>\n","protected":false},"author":16,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"_autodraft_ids":[],"jetpack_post_was_ever_published":false,"_sb_is_suggestion_mode":false,"_sb_show_suggestion_boards":false,"_sb_show_comment_boards":false,"_sb_suggestion_history":"","_sb_update_block_changes":"","_is_real_time_mode":false,"_realtime_collaborators":"","footnotes":"","cf_checklist_status":[]},"categories":[12527],"tags":[],"class_list":["post-9921","post","type-post","status-publish","format-standard","hentry","category-addon-framework-filters","wpautop"],"acf":[],"yoast_head":"\ngform_addon_field_value - Gravity Forms Documentation<\/title>\n<meta name=\"description\" content=\"This filter can be used to modify a value before it is sent to a third-party by one of the Add-on Framework based add-ons.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"gform_addon_field_value\" \/>\n<meta property=\"og:description\" content=\"This filter can be used to modify a value before it is sent to a third-party by one of the Add-on Framework based add-ons.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/\" \/>\n<meta property=\"og:site_name\" content=\"Gravity Forms Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2015-12-23T20:05:38+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-04-18T15:22:08+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2023\/08\/gf-docs-default-v3.png\" \/>\n\t<meta property=\"og:image:width\" content=\"544\" \/>\n\t<meta property=\"og:image:height\" content=\"288\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Justin Pakes\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@gravityforms\" \/>\n<meta name=\"twitter:site\" content=\"@gravityforms\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Justin Pakes\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/\"},\"author\":{\"name\":\"Justin Pakes\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/person\\\/8a88745ec2ee5bc1bb24eea8634bf376\"},\"headline\":\"gform_addon_field_value\",\"datePublished\":\"2015-12-23T20:05:38+00:00\",\"dateModified\":\"2025-04-18T15:22:08+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/\"},\"wordCount\":241,\"publisher\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#organization\"},\"articleSection\":[\"Add-On Framework Filters\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/\",\"name\":\"gform_addon_field_value - Gravity Forms Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#website\"},\"datePublished\":\"2015-12-23T20:05:38+00:00\",\"dateModified\":\"2025-04-18T15:22:08+00:00\",\"description\":\"This filter can be used to modify a value before it is sent to a third-party by one of the Add-on Framework based add-ons.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform_addon_field_value\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/docs.gravityforms.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"gform_addon_field_value\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#website\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/\",\"name\":\"Gravity Forms Documentation\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/docs.gravityforms.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#organization\",\"name\":\"Gravity Forms\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/wp-content\\\/uploads\\\/2020\\\/01\\\/gravity-forms-2020-logo-stacked.png\",\"contentUrl\":\"https:\\\/\\\/docs.gravityforms.com\\\/wp-content\\\/uploads\\\/2020\\\/01\\\/gravity-forms-2020-logo-stacked.png\",\"width\":392,\"height\":515,\"caption\":\"Gravity Forms\"},\"image\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/x.com\\\/gravityforms\",\"http:\\\/\\\/@gravityforms.com\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/person\\\/8a88745ec2ee5bc1bb24eea8634bf376\",\"name\":\"Justin Pakes\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/791cb5bec00c6dd4bec2e80cf4df9638297207d8f77890c96b6b483be434ecea?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/791cb5bec00c6dd4bec2e80cf4df9638297207d8f77890c96b6b483be434ecea?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/791cb5bec00c6dd4bec2e80cf4df9638297207d8f77890c96b6b483be434ecea?s=96&d=mm&r=g\",\"caption\":\"Justin Pakes\"},\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/author\\\/pakes\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"gform_addon_field_value - Gravity Forms Documentation","description":"This filter can be used to modify a value before it is sent to a third-party by one of the Add-on Framework based add-ons.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/","og_locale":"en_US","og_type":"article","og_title":"gform_addon_field_value","og_description":"This filter can be used to modify a value before it is sent to a third-party by one of the Add-on Framework based add-ons.","og_url":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/","og_site_name":"Gravity Forms Documentation","article_published_time":"2015-12-23T20:05:38+00:00","article_modified_time":"2025-04-18T15:22:08+00:00","og_image":[{"width":544,"height":288,"url":"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2023\/08\/gf-docs-default-v3.png","type":"image\/png"}],"author":"Justin Pakes","twitter_card":"summary_large_image","twitter_creator":"@gravityforms","twitter_site":"@gravityforms","twitter_misc":{"Written by":"Justin Pakes","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/#article","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/"},"author":{"name":"Justin Pakes","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/person\/8a88745ec2ee5bc1bb24eea8634bf376"},"headline":"gform_addon_field_value","datePublished":"2015-12-23T20:05:38+00:00","dateModified":"2025-04-18T15:22:08+00:00","mainEntityOfPage":{"@id":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/"},"wordCount":241,"publisher":{"@id":"https:\/\/docs.gravityforms.com\/#organization"},"articleSection":["Add-On Framework Filters"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/","url":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/","name":"gform_addon_field_value - Gravity Forms Documentation","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/#website"},"datePublished":"2015-12-23T20:05:38+00:00","dateModified":"2025-04-18T15:22:08+00:00","description":"This filter can be used to modify a value before it is sent to a third-party by one of the Add-on Framework based add-ons.","breadcrumb":{"@id":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.gravityforms.com\/gform_addon_field_value\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.gravityforms.com\/gform_addon_field_value\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.gravityforms.com\/"},{"@type":"ListItem","position":2,"name":"gform_addon_field_value"}]},{"@type":"WebSite","@id":"https:\/\/docs.gravityforms.com\/#website","url":"https:\/\/docs.gravityforms.com\/","name":"Gravity Forms Documentation","description":"","publisher":{"@id":"https:\/\/docs.gravityforms.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.gravityforms.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.gravityforms.com\/#organization","name":"Gravity Forms","url":"https:\/\/docs.gravityforms.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/logo\/image\/","url":"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2020\/01\/gravity-forms-2020-logo-stacked.png","contentUrl":"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2020\/01\/gravity-forms-2020-logo-stacked.png","width":392,"height":515,"caption":"Gravity Forms"},"image":{"@id":"https:\/\/docs.gravityforms.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/gravityforms","http:\/\/@gravityforms.com"]},{"@type":"Person","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/person\/8a88745ec2ee5bc1bb24eea8634bf376","name":"Justin Pakes","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/791cb5bec00c6dd4bec2e80cf4df9638297207d8f77890c96b6b483be434ecea?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/791cb5bec00c6dd4bec2e80cf4df9638297207d8f77890c96b6b483be434ecea?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/791cb5bec00c6dd4bec2e80cf4df9638297207d8f77890c96b6b483be434ecea?s=96&d=mm&r=g","caption":"Justin Pakes"},"url":"https:\/\/docs.gravityforms.com\/author\/pakes\/"}]}},"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/pdGaEa-2A1","_links":{"self":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/9921","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/users\/16"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/comments?post=9921"}],"version-history":[{"count":3,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/9921\/revisions"}],"predecessor-version":[{"id":43519,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/9921\/revisions\/43519"}],"wp:attachment":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/media?parent=9921"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/categories?post=9921"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/tags?post=9921"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}