gppa-force-lmt-populate-on-edit.php: Added snippet to update Live Merge Tags when editing entries.
#1093
Conversation
…erge Tags when editing entries.
WalkthroughA new PHP script has been added to ensure that Gravity Forms fields using Populate Anything live merge tags are dynamically repopulated whenever an entry is edited. The script hooks into the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GravityForms
participant CustomScript
User->>GravityForms: Edit and update entry
GravityForms->>CustomScript: Trigger gform_after_update_entry hook
CustomScript->>GravityForms: Retrieve form and entry data
loop For each field in form
CustomScript->>CustomScript: Check for live merge tags in field default value
CustomScript->>GravityForms: Process and replace merge tags with current entry data
CustomScript->>GravityForms: Update entry field value
end
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
gp-populate-anything/gppa-force-lmt-populate-on-edit.php (2)
20-23: Consider validating the preg_replace result.The code uses
preg_replace()without checking if the pattern replacement succeeded. While this specific pattern is simple, it's a good practice to validate regex operations.// Process the Live Merge Tags. -$merge_tag = preg_replace( '/@(?=\{)/', '', $field->defaultValue ); +$merge_tag = preg_replace( '/@(?=\{)/', '', $field->defaultValue ); +if ( $merge_tag === null ) { + // Handle preg_replace error + continue; +} $value = GFCommon::replace_variables( $merge_tag, $form, $entry );
24-26: Missing validation before updating entry field.The code updates the entry field without validating the generated value. Consider adding a check to ensure the value is appropriate before updating.
// Store updated value on the entry. +// Skip update if value didn't change +$current_value = rgar( $entry, $field->id ); +if ( $current_value !== $value ) { GFFormsModel::update_entry_field_value( $form, $entry, $field, '', $field->id, $value ); +}
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
gp-populate-anything/gppa-force-lmt-populate-on-edit.php(1 hunks)
🔇 Additional comments (3)
gp-populate-anything/gppa-force-lmt-populate-on-edit.php (3)
1-10: Well-documented snippet with clear purpose.The documentation header clearly explains the purpose of the snippet and includes useful references to documentation and a demonstration video. This is excellent practice for maintainability.
14-16: LGTM: Logical field iteration with proper validation.The code correctly iterates through form fields and checks for the presence of live merge tags in the default values.
27-28: Good priority setting for the hook.Setting the priority to 15 ensures this runs after Gravity Forms' default handlers (typically at priority 10) but before most custom code (which often uses higher priorities).
| add_action( 'gform_after_update_entry', function ( $form, $entry_id ) { | ||
| $gppa_lmt = GP_Populate_Anything_Live_Merge_Tags::get_instance(); | ||
| $entry = GFAPI::get_entry( $entry_id ); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Missing error handling for entry retrieval.
The code retrieves an entry but doesn't validate whether it was successful. If the entry doesn't exist or there's an API error, this could lead to PHP notices or errors.
add_action( 'gform_after_update_entry', function ( $form, $entry_id ) {
$gppa_lmt = GP_Populate_Anything_Live_Merge_Tags::get_instance();
$entry = GFAPI::get_entry( $entry_id );
+ if ( is_wp_error( $entry ) ) {
+ return;
+ }| <?php | ||
| /** | ||
| * Gravity Forms // Populate Anything // Force Dynamic Population When Editing Entry. | ||
| * https://gravitywiz.com/documentation/gravity-forms-populate-anything/ | ||
| * | ||
| * Instruction Video: https://www.loom.com/share/6a7f28fc0cde406798d5bad4b386a70a | ||
| * | ||
| * Use this snippet to force fields to be dynamically repopulated via Populate Anything when they are | ||
| * edited via the Gravity Forms edit entry screen. | ||
| */ | ||
| add_action( 'gform_after_update_entry', function ( $form, $entry_id ) { | ||
| $gppa_lmt = GP_Populate_Anything_Live_Merge_Tags::get_instance(); | ||
| $entry = GFAPI::get_entry( $entry_id ); | ||
| foreach ( $form['fields'] as $field ) { | ||
| // For any field having Live Merge Tags. | ||
| if ( $gppa_lmt->has_live_merge_tag( $field->defaultValue ) ) { | ||
| $gppa_lmt->populate_lmt_whitelist( $form ); | ||
| remove_all_filters('gform_pre_replace_merge_tags'); | ||
|
|
||
| // Process the Live Merge Tags. | ||
| $merge_tag = preg_replace( '/@(?=\{)/', '', $field->defaultValue ); | ||
| $value = GFCommon::replace_variables( $merge_tag, $form, $entry ); | ||
|
|
||
| // Store updated value on the entry. | ||
| GFFormsModel::update_entry_field_value( $form, $entry, $field, '', $field->id, $value ); | ||
| } | ||
| } | ||
| }, 15, 2 ); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider validating plugin dependencies.
The code assumes that GP Populate Anything and its classes are available. Consider adding a check to ensure the required classes exist before executing the main functionality.
<?php
/**
* Gravity Forms // Populate Anything // Force Dynamic Population When Editing Entry.
* https://gravitywiz.com/documentation/gravity-forms-populate-anything/
*
* Instruction Video: https://www.loom.com/share/6a7f28fc0cde406798d5bad4b386a70a
*
* Use this snippet to force fields to be dynamically repopulated via Populate Anything when they are
* edited via the Gravity Forms edit entry screen.
*/
+// Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) {
+ exit;
+}
+
+// Check if required plugins/classes exist
+if ( ! class_exists( 'GP_Populate_Anything_Live_Merge_Tags' ) || ! class_exists( 'GFAPI' ) ) {
+ return;
+}
+
add_action( 'gform_after_update_entry', function ( $form, $entry_id ) {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <?php | |
| /** | |
| * Gravity Forms // Populate Anything // Force Dynamic Population When Editing Entry. | |
| * https://gravitywiz.com/documentation/gravity-forms-populate-anything/ | |
| * | |
| * Instruction Video: https://www.loom.com/share/6a7f28fc0cde406798d5bad4b386a70a | |
| * | |
| * Use this snippet to force fields to be dynamically repopulated via Populate Anything when they are | |
| * edited via the Gravity Forms edit entry screen. | |
| */ | |
| add_action( 'gform_after_update_entry', function ( $form, $entry_id ) { | |
| $gppa_lmt = GP_Populate_Anything_Live_Merge_Tags::get_instance(); | |
| $entry = GFAPI::get_entry( $entry_id ); | |
| foreach ( $form['fields'] as $field ) { | |
| // For any field having Live Merge Tags. | |
| if ( $gppa_lmt->has_live_merge_tag( $field->defaultValue ) ) { | |
| $gppa_lmt->populate_lmt_whitelist( $form ); | |
| remove_all_filters('gform_pre_replace_merge_tags'); | |
| // Process the Live Merge Tags. | |
| $merge_tag = preg_replace( '/@(?=\{)/', '', $field->defaultValue ); | |
| $value = GFCommon::replace_variables( $merge_tag, $form, $entry ); | |
| // Store updated value on the entry. | |
| GFFormsModel::update_entry_field_value( $form, $entry, $field, '', $field->id, $value ); | |
| } | |
| } | |
| }, 15, 2 ); | |
| <?php | |
| /** | |
| * Gravity Forms // Populate Anything // Force Dynamic Population When Editing Entry. | |
| * https://gravitywiz.com/documentation/gravity-forms-populate-anything/ | |
| * | |
| * Instruction Video: https://www.loom.com/share/6a7f28fc0cde406798d5bad4b386a70a | |
| * | |
| * Use this snippet to force fields to be dynamically repopulated via Populate Anything when they are | |
| * edited via the Gravity Forms edit entry screen. | |
| */ | |
| // Exit if accessed directly | |
| if ( ! defined( 'ABSPATH' ) ) { | |
| exit; | |
| } | |
| // Check if required plugins/classes exist | |
| if ( ! class_exists( 'GP_Populate_Anything_Live_Merge_Tags' ) || ! class_exists( 'GFAPI' ) ) { | |
| return; | |
| } | |
| add_action( 'gform_after_update_entry', function ( $form, $entry_id ) { | |
| $gppa_lmt = GP_Populate_Anything_Live_Merge_Tags::get_instance(); | |
| $entry = GFAPI::get_entry( $entry_id ); | |
| foreach ( $form['fields'] as $field ) { | |
| // For any field having Live Merge Tags. | |
| if ( $gppa_lmt->has_live_merge_tag( $field->defaultValue ) ) { | |
| $gppa_lmt->populate_lmt_whitelist( $form ); | |
| remove_all_filters( 'gform_pre_replace_merge_tags' ); | |
| // Process the Live Merge Tags. | |
| $merge_tag = preg_replace( '/@(?=\{)/', '', $field->defaultValue ); | |
| $value = GFCommon::replace_variables( $merge_tag, $form, $entry ); | |
| // Store updated value on the entry. | |
| GFFormsModel::update_entry_field_value( $form, $entry, $field, '', $field->id, $value ); | |
| } | |
| } | |
| }, 15, 2 ); |
| $gppa_lmt->populate_lmt_whitelist( $form ); | ||
| remove_all_filters('gform_pre_replace_merge_tags'); |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Potential side effect when removing filters.
The remove_all_filters('gform_pre_replace_merge_tags') call removes all filters, which could affect other functionality that relies on these filters. Consider using a more targeted approach or restoring filters afterward.
🏁 Script executed:
#!/bin/bash
# Check if other code is using the same filter
rg "add_filter\(\s*['\"]gform_pre_replace_merge_tags['\"]" --type phpLength of output: 1284
🏁 Script executed:
#!/bin/bash
# Display the first 200 lines of the file to understand the context around the remove_all_filters call
sed -n '1,200p' gp-populate-anything/gppa-force-lmt-populate-on-edit.phpLength of output: 1253
Avoid Removing All gform_pre_replace_merge_tags Filters
Removing all filters on gform_pre_replace_merge_tags will clear callbacks added by other plugins and add-ons (e.g. gw-cache-buster, gw-all-fields-template, gw-format-date-merge-tags, gw-merge-tag-tab, gw-multi-file-merge-tag, gppa-page-modifier, gp-advanced-phone-field, etc.), likely breaking their functionality.
Consider one of these targeted approaches:
- Remove only your own callback instead of all filters:
remove_filter( 'gform_pre_replace_merge_tags', [ $gppa_lmt, 'your_specific_callback' ], $your_callback_priority, $your_callback_arg_count );
- Or back up & restore the original filter list around your merge-tag processing:
$tag = 'gform_pre_replace_merge_tags'; $original_filters = $GLOBALS['wp_filter'][ $tag ] ?? []; // Whitelist and add only necessary WP filters $gppa_lmt->populate_lmt_whitelist( $form ); // Process merge tags $value = GFCommon::replace_variables( $merge_tag, $form, $entry ); // Restore all other filters $GLOBALS['wp_filter'][ $tag ] = $original_filters;
Please update gppa-force-lmt-populate-on-edit.php to use one of these patterns so you don’t unintentionally disable other integrations.
Context
⛑️ Ticket(s): https://secure.helpscout.net/conversation/2918356655/82575
💬 Slack: https://gravitywiz.slack.com/archives/D042XMBHJ91/p1745768566723809?thread_ts=1745647036.839519&cid=D042XMBHJ91
Summary
Live Merge Tags does not appear to be working when editing entries via the Entry Details page.
Snippet Demo:
https://www.loom.com/share/6a7f28fc0cde406798d5bad4b386a70a