Skip to content

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions gravity-forms/gw-display-html-field-on-entry-detail.php
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 );
Copy link
Contributor

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:

  • That would allow this to work on existing entries without needing to update the entry to trigger the HTML content generation.
  • Updates to the snippet would then automatically apply rather than needing to go back through and manually updating / saving entries to get the updates reflected in the displayed data.

Copy link
Contributor Author

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.

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 ) {
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;
}

$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.
) );
Loading