Address field

You are here:
< All Topics

Introduction

The Address field makes it quick and easy to capture address information on a form. This field provides a pre-formatted area for two street addresses, city, state/province, zip/postal code, and a drop down for country selection. It is available under the Advanced Fields section within the form editor.

Address Field in Form Editor

Common Settings

For a description of each of the common field settings, refer to this article. Below you will find description of specialty settings that are particular to this field.

General Settings

Address Field General Settings

Address Type

Select the type of address you would like to use.

International

The International address type is the default address type and supports most address formats internationally.

Address Field International Type Settings
United States

The United States address type is formatted specifically for addresses within the United States.

Address Field United States Type Settings
Canadian

The Canadian address type is formatted specifically for addresses within Canada.

Address Field Canada Type Settings
Custom

Do you need to support an address type that is not compatible with any of the predefined options? No worries! You can add support for a new address type easily by using the gform_address_types filter. This filter can also be used to update the format of the predefined options as well.

Address Fields

Within this section, you can use the toggle switches to enable or disable specific data within the address field.

Default Country/State/Province

Based on your selection within the Address Type, options will dynamically populate for the default country, state, or province. They can be selected here if you would like these to default to a specific location.

Appearance Settings

Address Field Appearance Settings
Sub-Label Placement

Similar to the Description Placement option, but instead applies to the sub-label.

Advanced Settings

Address Field Advanced Settings
Display option to use the values submitted in different field

This may be used to populate the field from the information on another field. This is useful in cases such as shipping/billing address fields, where they may be the same information.

Option Label

This determines the text that will be displayed next to the checkbox listed next to the field, which allows copying of the data. An example of this would be: Copy address from billing address.

Source Field

Within this option, you will determine the field that will provide the data to this field.

Activated by default

This option is used to activate population of the field based on another, by default.

Conditional Logic Support

Starting with Gravity Forms 2.0 you can configure conditional logic rules on other fields based on the values of the Address field inputs.

CSS Targeting Examples

Address Field Targeting Examples

Extending the Address Field

Looking for information about what properties the Address field uses in the Field Object, what format its value is stored in the Entry Object and how you can access it, or what hooks/filters it includes? Then take a look at the GF_Field_Address article.

Merge Tags

Usage

Display the Street Address.

{Field Name:2.1}

Display the Address Line 2.

{Field Name:2.2}

Display the City.

{Field Name:2.3}

Display the State / Province.

{Field Name:2.4}

Display the ZIP / Postal Code.

{Field Name:2.5}

Display the Country.

{Field Name:2.6}

Modifiers

This merge tag does not have any modifiers.

Table of Contents