-
Notifications
You must be signed in to change notification settings - Fork 92
gw-display-html-field-on-entry-detail.php: Added a snippet to display HTML field content on Entry Details page.
#1074
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
2d09bfd
24a9e26
576d849
50ff4df
bddad13
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| <?php | ||
| /** | ||
| * Gravity Wiz // Gravity Forms // Display HTML Field on Entry Details | ||
| * | ||
| * Instruction Video: https://www.loom.com/share/fa4b49240b6447c7839392af69476bf2 | ||
| * | ||
| * Save and display HTML field content (including Live Merge Tags and shortcodes) in the entry detail view. | ||
| * Useful for retaining dynamic HTML field output as it appeared when the entry was submitted. | ||
| * | ||
| * Plugin Name: Display HTML Field on Entry Details | ||
| * Plugin URI: http://gravitywiz.com/ | ||
| * Description: Save and display HTML field content (including Live Merge Tags and shortcodes) in the entry detail view. | ||
| * Author: Gravity Wiz | ||
| * Version: 0.1 | ||
| * Author URI: http://gravitywiz.com | ||
| */ | ||
| class GW_Display_HTML_Field_Entry_Detail { | ||
|
|
||
| private $_args = array(); | ||
|
|
||
| public function __construct( $args = array() ) { | ||
| $this->_args = wp_parse_args( | ||
| $args, | ||
| array( | ||
| 'form_id' => false, | ||
| 'field_id' => false, | ||
| ) | ||
| ); | ||
|
|
||
| add_action( 'init', array( $this, 'init' ) ); | ||
| } | ||
|
|
||
| public function init() { | ||
| add_filter( 'gform_entry_post_save', array( $this, 'save_html_field_content' ), 10, 1 ); | ||
| add_action( 'gform_entry_detail', array( $this, 'display_html_field_content_entry_detail' ), 10, 2 ); | ||
| add_filter( 'gform_get_input_value', array( $this, 'display_html_field_content_entry_list' ), 10, 4 ); | ||
| } | ||
|
|
||
| private function is_applicable_form( $form ) { | ||
| $form_id = is_array( $form ) && isset( $form['id'] ) ? $form['id'] : (int) $form; | ||
| return empty( $this->_args['form_id'] ) || (int) $form_id === (int) $this->_args['form_id']; | ||
| } | ||
|
|
||
| private function is_applicable_field( $field ) { | ||
| return $field->get_input_type() === 'html' && | ||
| ( empty( $this->_args['field_id'] ) || (int) $field->id === (int) $this->_args['field_id'] ); | ||
| } | ||
|
|
||
| private function process_html_content( $content, $form, $entry ) { | ||
| // Process Live Merge Tags. | ||
| if ( | ||
| method_exists( 'GP_Populate_Anything_Live_Merge_Tags', 'has_live_merge_tag' ) && | ||
| GP_Populate_Anything_Live_Merge_Tags::get_instance()->has_live_merge_tag( $content ) | ||
| ) { | ||
| $content = gp_populate_anything()->live_merge_tags->replace_live_merge_tags_static( $content, $form, $entry ); | ||
| } | ||
|
|
||
| // Replace merge tags and shortcodes. | ||
| $content = GFCommon::replace_variables( $content, $form, $entry ); | ||
| $content = do_shortcode( $content ); | ||
|
|
||
| return ! empty( $content ) ? wp_kses_post( $content ) : ''; | ||
| } | ||
|
|
||
| public function save_html_field_content( $entry ) { | ||
| $form = GFAPI::get_form( rgar( $entry, 'form_id' ) ); | ||
|
|
||
| if ( ! $this->is_applicable_form( $form ) ) { | ||
| return $entry; | ||
| } | ||
|
|
||
| foreach ( $form['fields'] as $field ) { | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if ( $this->is_applicable_field( $field ) ) { | ||
| gform_update_meta( $entry['id'], 'html_field_' . $field->id, $field->content ); | ||
| } | ||
| } | ||
|
|
||
| return $entry; | ||
| } | ||
|
|
||
| public function display_html_field_content_entry_detail( $form, $entry ) { | ||
| if ( ! $this->is_applicable_form( $form ) ) { | ||
| return; | ||
| } | ||
|
|
||
| foreach ( $form['fields'] as $field ) { | ||
| if ( $this->is_applicable_field( $field ) ) { | ||
| $content = gform_get_meta( $entry['id'], 'html_field_' . $field->id ); | ||
| $content = $this->process_html_content( $content, $form, $entry ); | ||
|
|
||
| if ( $content ) { | ||
| printf( | ||
| '<h4>%s</h4><div>%s</div><hr>', | ||
| esc_html( $field->label ), | ||
| $content | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public function display_html_field_content_entry_list( $value, $entry, $field, $input_id ) { | ||
| static $is_running = false; | ||
|
|
||
| if ( $is_running || rgget( 'page' ) !== 'gf_entries' || ! $this->is_applicable_field( $field ) ) { | ||
| return $value; | ||
| } | ||
|
|
||
| $form = GFAPI::get_form( $field->formId ); | ||
| if ( ! $this->is_applicable_form( $form ) ) { | ||
| return $value; | ||
| } | ||
|
Comment on lines
+88
to
+91
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add validation for the form object returned by GFAPI::get_form(). The $form = GFAPI::get_form( $field->formId );
+if ( ! is_array( $form ) ) {
+ return $value;
+}
+
if ( ! $this->is_applicable_form( $form ) ) {
return $value;
}🤖 Prompt for AI Agents |
||
|
|
||
| $is_running = true; | ||
| $entry = GFAPI::get_entry( $entry['id'] ); | ||
| $content = gform_get_meta( $entry['id'], 'html_field_' . $field->id ); | ||
| $content = $this->process_html_content( $content, $form, $entry ); | ||
| $is_running = false; | ||
|
|
||
| return $content ?: $value; | ||
| } | ||
| } | ||
|
|
||
| # Configuration | ||
| new GW_Display_HTML_Field_Entry_Detail( array( | ||
| 'form_id' => 846, // Replace with your form ID or leave false for all. | ||
| 'field_id' => 4, // Replace with your HTML field ID or leave false to process all HTML fields. | ||
| ) ); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about generating the HTML content on entry detail page load instead of persisting the info with the entry?
Two reasons:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@veryspry 🤔 From what I am able to recall, one reason for doing it this way to ensure dynamic loading of any updated HTML content.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@saifsultanc wouldn't it work the opposite the way it is — like wouldn't the content only update after the entry is saved? Or is that okay as this is displaying HTML Field content that would only ever change if the field is updated?
I guess either way, I don't know if the additional
metais required here as the content is already available on the$fielditself, right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great point and I guess you're right. After reviewing the code again, I realized we're only storing the unprocessed HTML content in meta, which is already available via $field->content. So persisting it adds unnecessary complexity without giving us a true "snapshot."
I'll gone ahead and refactored this to render the HTML dynamically. @veryspry