October 5, 2013: Updated snippet to use a class format for easier instantiation which also adds support for applying to multiple forms and multiple fields on the same form.
January 26, 2013: Updated to better select the current list field table rows.
| <?php | |
| /** | |
| * Gravity Wiz // Gravity Forms // Set Number of List Field Rows by Field Value | |
| * | |
| * Add/remove list field rows automatically based on the value entered in the specified field. Removes the add/remove | |
| * that normally buttons next to List field rows. | |
| * | |
| * @version 1.0 | |
| * @author David Smith <david@gravitywiz.com> | |
| * @license GPL-2.0+ | |
| * @link https://gravitywiz.com/2012/06/03/set-number-of-list-field-rows-by-field-value/ | |
| */ | |
| class GWAutoListFieldRows { | |
| private static $_is_script_output; | |
| function __construct( $args ) { | |
| $this->_args = wp_parse_args( $args, array( | |
| 'form_id' => false, | |
| 'input_html_id' => false, | |
| 'list_field_id' => false | |
| ) ); | |
| extract( $this->_args ); // gives us $form_id, $input_html_id, and $list_field_id | |
| if( ! $form_id || ! $input_html_id || ! $list_field_id ) | |
| return; | |
| add_filter( 'gform_pre_render_' . $form_id, array( $this, 'pre_render' ) ); | |
| } | |
| function pre_render( $form ) { | |
| ?> | |
| <style type="text/css"> #field_<?php echo $form['id']; ?>_<?php echo $this->_args['list_field_id']; ?> .gfield_list_icons { display: none; } </style> | |
| <?php | |
| add_filter( 'gform_register_init_scripts', array( $this, 'register_init_script' ) ); | |
| if( ! self::$_is_script_output ) | |
| $this->output_script(); | |
| return $form; | |
| } | |
| function register_init_script( $form ) { | |
| // remove this function from the filter otherwise it will be called for every other form on the page | |
| remove_filter( 'gform_register_init_scripts', array( $this, 'register_init_script' ) ); | |
| $args = array( | |
| 'formId' => $this->_args['form_id'], | |
| 'listFieldId' => $this->_args['list_field_id'], | |
| 'inputHtmlId' => $this->_args['input_html_id'] | |
| ); | |
| $script = "new gwalfr(" . json_encode( $args ) . ");"; | |
| $key = implode( '_', $args ); | |
| GFFormDisplay::add_init_script( $form['id'], 'gwalfr_' . $key , GFFormDisplay::ON_PAGE_RENDER, $script ); | |
| } | |
| function output_script() { | |
| ?> | |
| <script type="text/javascript"> | |
| window.gwalfr; | |
| (function($){ | |
| gwalfr = function( args ) { | |
| this.formId = args.formId, | |
| this.listFieldId = args.listFieldId, | |
| this.inputHtmlId = args.inputHtmlId; | |
| this.init = function() { | |
| var gwalfr = this, | |
| triggerInput = $( this.inputHtmlId ); | |
| // update rows on page load | |
| this.updateListItems( triggerInput, this.listFieldId, this.formId ); | |
| // update rows when field value changes | |
| triggerInput.change(function(){ | |
| gwalfr.updateListItems( $(this), gwalfr.listFieldId, gwalfr.formId ); | |
| }); | |
| } | |
| this.updateListItems = function( elem, listFieldId, formId ) { | |
| var listField = $( '#field_' + formId + '_' + listFieldId ), | |
| count = parseInt( elem.val() ); | |
| rowCount = listField.find( 'table.gfield_list tbody tr' ).length, | |
| diff = count - rowCount; | |
| if( diff > 0 ) { | |
| for( var i = 0; i < diff; i++ ) { | |
| listField.find( '.add_list_item:last' ).click(); | |
| } | |
| } else { | |
| // make sure we never delete all rows | |
| if( rowCount + diff == 0 ) | |
| diff++; | |
| for( var i = diff; i < 0; i++ ) { | |
| listField.find( '.delete_list_item:last' ).click(); | |
| } | |
| } | |
| } | |
| this.init(); | |
| } | |
| })(jQuery); | |
| </script> | |
| <?php | |
| } | |
| } | |
| // EXAMPLE #1: Number field for the "input_html_id" | |
| new GWAutoListFieldRows( array( | |
| 'form_id' => 240, | |
| 'list_field_id' => 3, | |
| 'input_html_id' => '#input_240_4' | |
| ) ); | |
| // EXAMPLE #2: Single Product Field's Quantity input as the "input_html_id" | |
| new GWAutoListFieldRows( array( | |
| 'form_id' => 240, | |
| 'list_field_id' => 6, | |
| 'input_html_id' => '#ginput_quantity_240_5' | |
| ) ); |
Found this interesting question on the Gravity Forms forum:
I’m selling tickets. So each ticket needs to be associated with a name/email/etc…
Basically, the user needs a way to gather a set of data per ordered product/ticket. My first instinct was to simply recommend using the List field. The user could specify the number of tickets and then add/remove however many rows they need.
I kept thinking on it and realized it would be really nice if the number of List field rows increased/decreased automatically based on the number of selected tickets. Here’s a snippet to do just that!
How do I install this snippet?
Just copy and paste the snippet above into your theme’s functions.php file.
Do I need to modify this snippet to work with my form?
You just need to create your own instance of the GWAutoListFieldRows class. You’ll find two examples at the bottom of the snippet. Comment them out and then add your own! All you need to set is the $form_id, the $list_field_id, and the HTML id of your input as the $input_html_id property.
Summary
The one piece missing from this snippet is that regardless of how many rows are displayed, none of these rows are actually required. If this functionality is useful, I will dig into this shortcoming and provide a more robust solution.
Did this resource help you do something awesome with Gravity Forms? Then you'll absolutely love Gravity Perks; a suite of 29+ essential add-ons for Gravity Forms with support you can count on.
I’m trying to run two instances of the code in one form. The first instance is running fine. But the second is not working. I double checked the field Id’s and everything seems to be correct. Any ideas??
new GWAutoListFieldRows( array( ‘form_id’ => 8, ‘list_field_id’ => 22, ‘input_html_id’ => ‘#ginput_quantity_8_16’ ) );
new GWAutoListFieldRows( array( ‘form_id’ => 8, ‘list_field_id’ => 20, ‘input_html_id’ => ‘#ginput_quantity_8_24’ ) );
Hi Adam, I tested this configuration locally and it works as expected. Just FYI, if you’re a Gravity Perks customer, you may be interested in our early-access GF Auto List Field perk available by request. It provides this same functionality but without the need to touch code.
hello there,
i don;t know if this forum is active, but im confused about $input_html_id where to find it? sorry im non dev guy.
THere’s not a great way to fetch the input’s HTML ID without viewing the source of the form. It’ll look something like this: https://gwiz.io/2Be3HvJ If you’d prefer to not touch any code, we do have a plugin version of this available to Gravity Perks users by request.
Hey David, Is this perk still available? I don’t see it in the list. -Rich
Hi Rich, it is an early-access perk, available by request for Gravity Perks users. 🙂
Hello! How do I put a value in the fields of this listing мф JS? For example, this does not work
$jq(‘.gfield_list_2_cell0 :input’).val(start);
How can I enable the “add” and “remove” buttons to show in the same form for another list field that is not using this script to function?
Do you have a URL where I could see this issue?
Is there a way to just indicate the number of list field rows that should be shown upon page load? My form will not have another field to indicate the number of rows required… I just need to show a minimum number of them for aesthetic purposes.
I don’t need/ wouldn’t want them to be required fields.
Just need say five rows to be shown on page-load, and allow the user to add more using the add another row icon.