Field Object

• Introduction
• Usage
• Properties
• Choice Properties
• Input Properties
• Field (input) Types
• Post 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

The following properties are common to multiple field types.

Choice Properties

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

Input Properties

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

Field (input) Types

For field type-specific properties, see the properties sections of the following articles:

• Address
• Calculation (Product)
• CAPTCHA
• Checkboxes
• Consent
• Credit Card (deprecated)
• Date
• Email
• File Upload
• Hidden
• Hidden (Product)
• HTML
• List
• Multi Select
• Name
• Number
• Page
• Password
• Phone
• Radio
• Section
• Select (Drop Down)
• Single Product
• Single Shipping
• Text
• Textarea (Paragraph)
• Time
• Total
• User Defined Price
• Website

Post 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
}