Gravity Forms All Fields Template

• April 16, 2021: Added support for filtering via custom function.

• November 9, 2020: Added support for excluding specific inputs of multi-input fields via the :exclude modifier.

• November 3, 2020: Migrated snippet to the Snippet Library.

• January 27, 2020: Added :nopricingfields modifier to hide pricing fields from {all_fields} output.

• September 5, 2019: Fixed notices generated in PHP7.3 by continue statements inside a foreach/switch.

• April 11, 2019: Updated priority of template replacement to avoid conflict with other merge tags replacement plugins.

The Gravity Forms {all_fields} merge tag provides a super simple way to output all of the submitted form data but it’s notoriously difficult to customize.

This plugin provides templating support for the {all_fields} merge tag. Huh? It means you can replace the markup generated by the merge tag with the contents of a file. This tutorial offers a solid starter template file too!

1. Getting Started
2. Template and Merge Tag Options
   1. Default Templates
   2. Form-specific Template
   3. Custom Template
   4. No Template
   5. Hide Pricing Fields
   6. Field Filtering Modifier
   7. GF Nested Forms Support
   8. Excluding Specific Inputs Within a Field
   9. Filter and Exclude Via Custom Function
3. Customizing the Template
   1. Digging Deeper
   2. Parameters
4. FAQs
   1. How do I hide Hidden fields from the {all_fields} merge tag?
   2. Hooks
5. Questions? Feedback?

Getting Started

This tutorial assumes you’re running a recent version of Gravity Forms, that you already have the {all_fields} merge tag implemented wherever you want, and that you ♥ Gravity Wiz.

	Download, install, and activate the plugin.
	Download the sample template directory/file. Add the folder to your active theme’s root directory: /wp-content/themes/{your-theme}/
	Customize the template as desired.

Template and Merge Tag Options

This plugin provides a few handy modifiers for controlling which template will be used to render the {all_fields} merge tag.

Note: All template paths are relative to your theme’s root directory.

Default Templates

Form-specific Template

Providing a form-specific template requires not changes to the merge tag. Simply append the targeted form ID to your template’s name. This template will now only be used with the merge tag is used in the context of the specified form.

Custom Template

You may want to create a custom template that should only be applied to specific instances of the merge tag. The “template” modifier allows you to specify a custom template suffix.

No Template

You may want to create a generic template that applies to all instances of the merge tag by default and then disable that template to use the default Gravity Forms merge tag output in a few specific instances.

Hide Pricing Fields

Hide pricing fields (i.e. order summary) from the {all_fields} output.

Field Filtering Modifier

These modifiers allow you to control which fields are output in the {all_fields} merge tag without having to touch any code.

Please note: you only need the plugin installed to use these modifiers. You do not need to install the template files in your theme.

GF Nested Forms Support

To filter which fields from a child form display in your {all_fields} merge tag you can use the :filter modifier and the [Nested Form Field ID].[Child Field ID] format (e.g., 4.3; where 4 is the Nested Form field ID and 3 is the child field ID from the child form).

You can use the :include, :exclude, :filter, and :index modifiers on the Nested Form field to filter which child fields should be displayed.

Excluding Specific Inputs Within a Field

Fields that contain multiple inputs, such as the Name field, can be excluded per-input by specifying the input ID. For example, to exclude the First Name, add .3 to the Field ID (e.g., 5.3; where 5 is the Name field).

This works for any field that contains multiple inputs, such as Name, Address, and Product. You can find the specific input IDs in Gravity Forms Documentation for Name and Address fields.

Filter and Exclude Via Custom Function

Custom functions can be used to identify fields for filtering. Using a custom modifier, the function should return an array of field IDs. For example, if you want to exclude fields with personal information from some instances of the {all_fields} merge tag, you could specify a custom modifier value like so:

{all_fields:exclude[persInfoFields]}

And then create a custom function to identify the IDs of those fields.

add_filter( 'gwaft_modifier_value_persInfoFields', function() {
    return array( 1, 2, 3 );
} );

This is useful in circumstances when you need to use the {all_fields} merge tag in multiple places and want to exclude the same fields in several contexts. Instead of having to copy the same string of field IDs to every place you’ve inserted the {all_fields} merge tag, you can specify the custom function once and use the custom filter wherever you need it. If you want change or add to the excluded fields in the future, you simply update the custom filter and it will be applied everywhere the filter is used.

Customizing the Template

Ok, don’t let this section intimidate you. Here’s the TLDR; Loop through $items, use $item['label'] for the field label, and $item['value'] for the field value. Here’s the simplest template you could have:

<ul>

	<?php foreach( $items as $item ): ?>

	<li>
		<strong><?php echo $item['label']; ?><strong><br>
		<?php echo $item['value']; ?>
	</li>

	<?php endforeach; ?>

</ul>

You’ll most likely want to use the sample template above as a starting point though as it takes care of a requirements to better align the template with Gravity Forms default All Fields functionality.

Digging Deeper

The {all_fields} template works like any other WordPress template with one exception. There is a special $items array available to you.

Each $item contains a label, value, and field property. The label and value are the exact label and value that the default {all_fields} merge tag would output. The field is the input-type-specific GF_Field object for the current field. This is useful when you want to alter the way a field is displayed depending on the field you’re working with.

Lastly, you have access to the current entry via the $entry variable and the current form via the $form variable. For more details on these variables, see the parameters section below.

Parameters

• $items array

  An array of items, each item containing the Gravity-Forms-formatted field label, field value and field object for the given field. The field label and field value are the same values that Gravity Forms outputs in the default {all_fields} merge tag.

  • label string

    The label of the current item/field.

  • value string

    The display value of the current item/field.

  • field GF_Field

    The input-type-specific GF_Field object for the current item/field.

• $entry Entry Object

  The current Gravity Forms Entry object.

• $form Form Object

  The current Gravity Forms Form object.

FAQs

How do I hide Hidden fields from the {all_fields} merge tag?

You can use the :nohidden merge tag modifier on the merge tag like this:

{all_fields:nohidden}

Hooks

• gwaft_modifier_value
  

Questions? Feedback?

What questions do you have? What features are missing? We’d like to make this into a more robust plugin and your feedback will be a big part of shaping the final product.