Field Object

• Introduction
• Usage
• Properties
• Basic Properties
• Post Fields
• Advanced Fields
• Number
• Date
• Phone
• Name and Address
• File Upload
• CAPTCHA
• Other
• Pricing Fields
• Add-On Fields
• Field JSON

Introduction

The Field object contains all settings for a particular field. It is part of the Form Object and is available in most Gravity Forms hooks. It can be manipulated to dynamically change the way the field is displayed.

Usage

// returns the label of the first field on the form
$form['fields'][0]->label;

// displays the types of every field in the form
foreach ( $form['fields'] as $field ) {
   echo $field->type . '<br/>';
}

Properties

Basic Properties

Note 1

$choices = $field->choices;
$choices[0]['text'] = 'Drop down item 1';
$field->choices = $choices;

• Each choice in the array has the following Properties:
  • text string The text to be displayed to the user when displaying this choice.
  • value string The value to be stored in the database when this choice is selected. Note: This property is only supported by the Drop Down and Post Category fields. Checkboxes and Radio fields will store the text property in the database regardless of the value property
  • isSelected bool Determines if this choice should be selected by default when displayed. The value 1 will select the choice, 0 will display it unselected.

Post Fields

Advanced Fields

Number

Date

Phone

Name and Address

Note 2

$inputs = $field->inputs;
$inputs[0]['label'] = 'First Name';
//sets the label for the first input
$field->inputs = $inputs

• Each input has the following properties.
  • id float The input id. Input Ids follow the following naming convention: “FIELDID.INPUTID” (i.e. 5.1), where FIELDID is the id of the containing field and INPUTID specifies the input field. For example, inputs for the name field are numbered as follows:
    • FIELDID.2 Name Prefix input id (i.e. 4.2)
    • FIELDID.3 First Name input id (i.e. 4.3)
    • FIELDID.6 Last Name input id (i.e. 4.6)
    • FIELDID.8 Name Suffix input id (i.e. 4.8)
  • label string Input label
  • name string When the field is configured with allowsPrepopulate set to 1, this property contains the parameter name to be used to populate this field (equivalent to the inputName property of single-input fields)

File Upload

CAPTCHA

Other

Pricing Fields

Add-On Fields

See the following pages for details about fields added by add-ons:

• Coupon
• Dropbox Upload

Field JSON

This example shows how a field object would look when formatted as JSON for use by the Gravity Forms CLI Add-On.

{
    "type": "select",
    "label": "My Dropdown",
    "choices": [{
        "text": "Choice 1",
        "value": "one"
    }, {
        "text": "Choice 2",
        "value": "two"
    }],
    "id": "2",
    "visibility": "visible",
    "formId": "14",
    "pageNumber": 1,
    "isRequired": false
}