Populate Child Entries
A brief description about this snippet and the functionality it provides. Might also include basic usage instructions if applicable.
Code
Filename: gppa-populate-child-entries.php
<?php
/**
* Gravity Perks // Populate Anything // Populate Child Entries
*
* Populate child entries from a Nested Form field into any multi-choice field.
*
* Instructional Video:
* https://www.loom.com/share/7b26b18f78624e0ca4bcd2b574636b8b
*
* Step 1 - Configure a Parent Entry Field
*
* 1. Add a Hidden field to your form.
* 2. Select the Advanced tab.
* 3. Check the "Allow field to be populated dynamically" option.
* 4. Enter "gpnf_parent_entry_id" as the "Parameter Name".
*
* Step 2 - Add Entries
*
* 1. Add any multi-choice field (e.g. Radio Buttons, Checkboxes, Drop Down).
* 2. Check the "Populate choices dynamically" option.
* 3. Select the desired child form for which you wish to fetch child entries.
* 4. Add a filter and filter where Parent Entry ID entry meta is equal to the Hidden field you created in Step 1.
*
* Important Note:
*
* If you want to use this with GravityView, you must use the Auto Attach Child Entries snippet:
* https://github.com/gravitywiz/snippet-library/blob/master/gp-nested-forms/gpnf-gv-auto-attach-child-entries.php
*
* Plugin Name: GP Populate Anything — Populate Child Entries
* Plugin URI: https://gravitywiz.com/documentation/gravity-forms-populate-anything/
* Description: A brief description about this snippet and the functionality it provides. Might also include basic usage instructions if applicable.
* Author: Gravity Wiz
* Version: 1.3
* Author URI: https://gravitywiz.com
*/
class GPPA_Populate_Child_Entries {
public function __construct( $args = array() ) {
// do version check in the init to make sure if GF is going to be loaded, it is already loaded
add_action( 'init', array( $this, 'init' ) );
}
public function init() {
if ( ! is_callable( 'gp_nested_forms' ) ) {
return;
}
add_filter( 'gform_field_value_gpnf_parent_entry_id', array( $this, 'populate_parent_entry_id' ), 10, 2 );
add_filter( 'gform_pre_render', array( $this, 'load_form_script' ), 10, 2 );
// Priority 11 so that it will initialize *after* Nested Forms.
add_filter( 'gform_register_init_scripts', array( $this, 'add_init_script' ), 11, 2 );
add_action( 'gravityview/edit-entry/render/before', array( $this, 'modify_gv_entry' ) );
}
public function populate_parent_entry_id( $value, $field ) {
if ( is_callable( 'gravityview_get_context' ) && gravityview_get_context() === 'edit' ) {
$value = GravityView_frontend::is_single_entry();
} else {
$session = new GPNF_Session( $field->formId );
$cookie = $session->get_cookie();
$value = rgar( $cookie, 'hash', '' );
}
return $value;
}
/**
* GV passes the full parent entry as field values when rendering the entry for editing. Populate Anything honors the
* submitted entry values rather than using the prepopulated values. To avoid this, let's unset those values from the
* entry before GV attempts to render the form.
*
* @param $gv_edit_entry_renderer
*/
public function modify_gv_entry( $gv_edit_entry_renderer ) {
$parent_entry_id_field_id = $this->get_parent_entry_id_field( $gv_edit_entry_renderer->form );
if ( $parent_entry_id_field_id ) {
unset( $gv_edit_entry_renderer->entry[ $parent_entry_id_field_id ] );
}
}
public function load_form_script( $form, $is_ajax_enabled ) {
if ( $this->is_applicable_form( $form ) && ! has_action( 'wp_footer', array( $this, 'output_script' ) ) ) {
add_action( 'wp_footer', array( $this, 'output_script' ) );
add_action( 'gform_preview_footer', array( $this, 'output_script' ) );
}
return $form;
}
public function output_script() {
?>
<script type="text/javascript">
( function( $ ) {
window.GPPAPopulateChildEntries = function( args ) {
var self = this;
// copy all args to current object: (list expected props)
for( var prop in args ) {
if( args.hasOwnProperty( prop ) ) {
self[ prop ] = args[ prop ];
}
}
self.init = function() {
self.$peidField = $( '#input_{0}_{1}'.gformFormat( self.formId, self.fieldId ) );
if ( typeof window[ 'gpnfSessionPromise_' + self.formId ] === 'undefined' ) {
gform.addAction( 'gpnf_session_initialized', function() {
self.setupPeidField();
} );
} else {
self.setupPeidField();
}
};
self.setupPeidField = function() {
var gpnfCookie = $.parseJSON( self.getCookie( 'gpnf_form_session_{0}'.gformFormat( self.formId ) ) );
if ( ! self.$peidField.val() ) {
self.$peidField
.val( gpnfCookie.hash )
.change();
}
for ( var i = 0; i < self.nestedFormFieldIds.length; i++ ) {
window[ 'GPNestedForms_{0}_{1}'.gformFormat( self.formId, self.nestedFormFieldIds[ i ] ) ].viewModel.entries.subscribe( function( entries ) {
self.$peidField.data( 'lastValue', '' ).change();
} );
}
}
self.getCookie = function( name ) {
var cookieArr = document.cookie.split( ';' );
for( var i = 0; i < cookieArr.length; i++ ) {
var cookiePair = cookieArr[ i ].split( '=' );
if ( name == cookiePair[0].trim() ) {
return decodeURIComponent( cookiePair[1] );
}
}
return null;
}
self.init();
}
} )( jQuery );
</script>
<?php
}
public function add_init_script( $form ) {
if ( ! $this->is_applicable_form( $form ) ) {
return;
}
$args = array(
'formId' => $form['id'],
'fieldId' => $this->get_parent_entry_id_field( $form ),
'nestedFormFieldIds' => wp_list_pluck( $this->get_nested_form_fields( $form ), 'id' ),
);
$script = 'new GPPAPopulateChildEntries( ' . json_encode( $args ) . ' );';
$slug = implode( '_', array( 'gppa_populate_child_entries', $args['formId'], $args['fieldId'] ) );
GFFormDisplay::add_init_script( $args['formId'], $slug, GFFormDisplay::ON_PAGE_RENDER, $script );
}
public function is_applicable_form( $form ) {
return $this->get_parent_entry_id_field( $form ) !== false && ! rgempty( $this->get_nested_form_fields( $form ) );
}
public function get_parent_entry_id_field( $form ) {
foreach ( $form['fields'] as $field ) {
if ( $field->inputName === 'gpnf_parent_entry_id' ) {
return $field->id;
}
}
return false;
}
public function get_nested_form_fields( $form ) {
return GFAPI::get_fields_by_type( $form, 'form', false );
}
}
# Configuration
new GPPA_Populate_Child_Entries();