GF_Field_Text

GF_Field_Text

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Text class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Single Line Text field is rendered when the form is displayed and how its value is handled during and after form submission.
Settings and Properties
Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.
Properties contain the values specified by the settings and generally are part of the Field Object.
The properties may be retrieved by accessing the Field Object as follows:
12345//get the field$field = GFFormsModel::get_field( $form, 1 ); //get the admin label$admin_label = $field->adminLabel;
Settings
The following settings are available for the field:

admin_label_setting
Controls whether the 「Admin Field Label」 setting appears.

conditional_logic_field_setting
Controls whether the 「Enable Conditional Logic」 setting appears.

css_class_setting
Controls whether the 「Custom CSS Class」 setting displays. This allows a custom css to be used for the field.

default_value_setting
Controls whether the 「Default Values」 section displays. This allows a value to be set for the field.

description_setting
Controls whether the 「Description」 setting appears. This allows a description for the field to be displayed.

duplicate_setting
Controls whether the 「No Duplicates」 setting displays within the 「Rules」 section. This controls whether the same value may exist more than once in the database. The 「Rules」 setting must be active for this to display.

error_message_setting
Controls whether the 「Custom Validation Message」 setting which allows a custom message to be used appears.

input_mask_setting
Controls whether the 「Input Mask」 setting displays which allows you to select a visual guide for entering the data from a drop down list.

label_setting
Controls whether the 「Field Label」 setting which allows the label to be changed appears.

maxlen_setting
Controls whether the 「Maximum Characters」 setting displays. This controls how many characters are allowed to be entered into the field. This is currently used by the text, textarea, post content, and post excerpt fields.

password_field_setting
Controls whether the 「Enable Password Input」 setting displays which allows the text field to be used as a password field with the data replaced with asterisks as the user types.

placeholder_setting
Controls whether the 「Placeholders」 section appears. This allows placeholder text to display for the field.

prepopulate_field_setting
Controls whether the 「Allow field to be populated dynamically」 setting appears.

rules_setting
Controls whether the 「Rules」 settings section displays. The 「Required」 option shows when this is active.

size_setting
Controls whether the 「Field Size」 setting displays. This controls the size of the input field for fields to which it applies. The sizes are 「small」, 「medium」, and 「large」.

visibility_setting
Controls whether the 「Visibility」 setting displays. The controls whether the option of visibility being for 「Everyone」 or 「Admin Only」 can be set.

Properties
Below is a listing of the properties inherited from the parent class and ones specific to the field.

adminLabel string
The label to be used on admin pages instead of the label, useful for fields with long labels.

adminOnly boolean
Determines whether the field is visible to the user submitting the form, or only visible in the admin.

allowsPrepopulate boolean
Determines if the field values can be dynamically populated. Default is false.

conditionalLogic array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

cssClass string
The custom CSS class or classes to be added to the input tag for the field.

defaultValue string
The default value to be displayed in the input field.

description string
The field description.

descriptionPlacement string
The placement of the field description. The description may be placed 「above」 or 「below」 the field inputs. If the placement is not specified, then the description placement setting for the Form Layout is used.

enablePasswordInput boolean
Indicates whether the field displays as a password input field with the text displayed as asterisks instead of being visible.

errorMessage string
The custom error message to be displayed if the field fails validation.

formId integer
The form ID.

id integer
The field ID.

inputName string
The parameter name used when dynamically populating the field.

isRequired boolean
Marking the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.

label string
The field label that will be displayed on the form and on the admin pages.

maxLength string
The number of characters that the text is allowed to contain.

noDuplicates boolean
Determines if the value entered by the user may already exist in the database.

placeholder string
Placeholder text to give the user a hint on how to fill out the field. This is not submitted with the form.

size string
Controls the width of the input field. The choices are 「small」, 「medium」, and 「large」.

type string
The field type, which in this case is text.

Source Code
The source code is located in includes/fields/class-gf-field-text.php in the Gravity Forms folder of your sites plugins directory.

GF_Field_HiddenProduct

GF_Field_HiddenProduct

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_HiddenProduct class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Product field is rendered when it is the 「Hidden」 selection when the form is displayed and how its value is handled during and after form submission.
Settings and Properties
Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.
Properties contain the values specified by the settings and generally are part of the Field Object.
The properties may be retrieved by accessing the Field Object as follows:
12345//get the field$field = GFFormsModel::get_field( $form, 1 ); //get the admin label$admin_label = $field->adminLabel;
Settings
The following settings are available for the field:

base_price_setting
Determines whether the 「Price」 section displays. This allows a base price to be specified for the product.

Properties
Below is a listing of the properties inherited from the parent class and ones specific to the field.

adminLabel string
The label to be used on admin pages instead of the label, useful for fields with long labels.

allowsPrepopulate boolean
Determines if the field values can be dynamically populated. Default is false.

basePrice string
The price of the product. The value includes the formatting characters.

description string
The field description.

descriptionPlacement string
The placement of the field description. The description may be placed 「above」 or 「below」 the field inputs. If the placement is not specified, then the description placement setting for the Form Layout is used.

formId integer
The form ID.

id integer
The field ID.

inputs array
An array containing the the individual properties for each element of the single product field.

id integer
The id of the input field.

label string
The label for the input.

name string
The name of the parameter used for the input when dynamically populating the field.

An example of the array output is as follows:
1234567891011121314151617$inputs = array(            array(              'id'    => '1.1',              'label' => 'Product Name',              'name'  => 'param_product'            ),            array(              'id'    => '1.2',              'label' => 'Price',              'name'  => 'param_price'            ),            array(              'id'    => '1.3',              'label' => 'Quantity',              'name'  => 'param_qty'            ),          )

inputType string
The sub-type of a field. For instance, when the field is a Product field, the 「type」 is set to product and the 「inputType」 is set to hiddenproduct. When the field is created, the type is initially set using the 「type」 property. If 「inputType」 is not empty, then the 「inputType」 is used to create the field instead.

label string
The field label that will be displayed on the form and on the admin pages.

type string
The field type. The type is set to product. The 「inputType」 is set to hiddenproduct.

Source Code
The source code is located in includes/fields/class-gf-field-hiddenproduct.php in the Gravity Forms folder of your sites plugins directory.

GF_Field_Radio

GF_Field_Radio

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction

The GF_Field_Radio class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Radio Button field is rendered when the form is displayed and how its value is handled during and after form submission. This class also handles the Product, Product Option, and Shipping fields rendering when the field is a radio button.

Settings and Properties

Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.

Properties contain the values specified by the settings and generally are part of the Field Object.

The properties may be retrieved by accessing the Field Object as follows:

//get the field
$field = GFFormsModel::get_field( $form, 1 );

//get the admin label
$admin_label = $field->adminLabel;

Settings

The following settings are available for the field:

admin_label_settingControls whether the 「Admin Field Label」 setting appears.choices_settingDetermines whether the 「Choices」 setting displays. This section allows you to create different radio button selections and set associated values to each one. It also allows you to choose from a pre-defined set of data that may be used to create the radio buttons. Without this section, the radio button selections are limited to 「First Choice」, 「Second Choice」 and 「Third Choice」 and may not be changed in the editor. conditional_logic_field_settingControls whether the 「Enable Conditional Logic」 setting appears. css_class_settingControls whether the 「Custom CSS Class」 setting displays. This allows a custom css to be used for the field. description_settingControls whether the 「Description」 setting appears. This allows a description for the field to be displayed. duplicate_settingControls whether the 「No Duplicates」 setting displays within the 「Rules」 section. This controls whether the same value may exist more than once in the database. The 「Rules」 setting must be active for this to display. error_message_settingControls whether the 「Custom Validation Message」 setting which allows a custom message to be used appears. label_settingControls whether the 「Field Label」 setting which allows the label to be changed appears. other_choice_settingDetermines whether the 「Enable 「other」 choice」 setting displays. When checked, this creates a final text input as Other and allows the user to enter their own text. prepopulate_field_settingControls whether the 「Allow field to be populated dynamically」 setting appears. rules_settingControls whether the 「Rules」 settings section displays. The 「Required」 option shows when this is active. visibility_settingControls whether the 「Visibility」 setting displays. The controls whether the option of visibility being for 「Everyone」 or 「Admin Only」 can be set.

Properties
Below is a listing of the properties inherited from the parent class and ones specific to the field.

adminLabel string
The label to be used on admin pages instead of the label, useful for fields with long labels.

adminOnly boolean
Determines whether the field is visible to the user submitting the form, or only visible in the admin.

allowsPrepopulate boolean
Determines if the field values can be dynamically populated. Default is false.

choices array
An array containing the the individual properties for each radio button item.

text string
The text that is displayed

value string
The value that is used for the radio button when the form is submitted.

isSelected boolean
Indicates whether the radio button item is selected

isOtherChoice boolean
Indicates the radio button item is the 「Other」 choice.

price string
Used when the radio button is a Product, Product Option, or Shipping Field and contains the item price.

Below is what the output would look like:
$choices = array(
array(
'text' => 'First Choice',
'value' => 'one',
'isSelected' => false,
'price' => '$5.00' //only populated if a product, product option or shipping field
),
array(
'text' => 'Second Choice',
'value' => 'two',
'isSelected' => true,
'price' => ''
),
array(
'text' => 'Third Choice',
'value' => 'three',
'isSelected' => false,
'price' => ''
),
array(
'text' => 'Other',
'value' => 'gf_other_choice',
'isSelected' => false,
'isOtherChoice' => true
)
)

conditionalLogic array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

cssClass string
The custom CSS class or classes to be added to the input tag for the field.

defaultValue string
The radio button to be selected. This must match to a value for one of the items. This is only available when the radio button is a product option field.

description string
The field description.

descriptionPlacement string
The placement of the field description. The description may be placed 「above」 or 「below」 the field inputs. If the placement is not specified, then the description placement setting for the Form Layout is used.

enableChoiceValue boolean
Indicates whether the 「show values」 option within the 「Choices」 section of the editor is checked.

enableOtherChoice boolean
Indicates whether the 「Enable 「other」 choice」 option is checked in the editor.

enablePrice boolean
This property is used when the radio button is a product option field and will be set to true. If not associated with a product, then it is false.

errorMessage string
The custom error message to be displayed if the field fails validation.

formId integer
The form ID.

id integer
The field ID.

inputName string
The parameter name used when dynamically populating the field.

inputType string
Used when the field has a sub-type. For instance, when the radio button is a Product, Product Option, or Shipping field, then the 「type」 is set to product when a Product field, option when a Product Option and shipping when a Shipping field. The 「inputType」 is set to radio. When the field is created, the type is initially set using the 「type」 property. If 「inputType」 is not empty, then the 「inputType」 property is used to create the field instead.

isRequired boolean
Marking the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.

label string
The field label that will be displayed on the form and on the admin pages.

noDuplicates boolean
Determines if the value entered by the user may already exist in the database.

productField integer
The id of the product field to which the radio button is associated. This is used when the radio button is an 「option」 associated with a product.

type string
The field type. It is normally 「radio」, unless the radio buttons are a Product, Product Option, or Shipping field. The type is set to product when a Product Field, option when a Product Option field, and shipping when a Shipping field. The 「inputType」 is set to radio.

Source Code

The source code is located in includes/fields/class-gf-field-radio.php in the Gravity Forms folder of your sites plugins directory.

GF_Field_CreditCard

GF_Field_CreditCard

IntroductionSettings and PropertiesSettingsPropertiesHooksSource Code

Introduction
The GF_Field_CreditCard class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Credit Card field is rendered when the form is displayed and how its value is handled during and after form submission.
Settings and Properties
Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.
Properties contain the values specified by the settings and generally are part of the Field Object.
The properties may be retrieved by accessing the Field Object as follows:
12345//get the field$field = GFFormsModel::get_field( $form, 1 ); //get the credit card style$card_style = $field->creditCardStyle;
Settings
The following settings are available for the field:

admin_label_setting
Controls whether the 「Admin Field Label」 setting appears.

conditional_logic_field_setting
Controls whether the 「Enable Conditional Logic」 setting appears.

credit_card_setting
Controls whether the 「Supported Credit Cards」 section displays. This allows specific available credit cards to be selected for use.

credit_card_style_setting
Controls whether the 「Card Icon Style」 section displays. This allows the style of the credit card icons to be set to Standard or 3D.

css_class_setting
Controls whether the 「Custom CSS Class」 setting displays. This allows a custom css to be used for the field.

description_setting
Controls whether the 「Description」 setting appears. This allows a description for the field to be displayed.

error_message_setting
Controls whether the 「Custom Validation Message」 setting which allows a custom message to be used appears.

force_ssl_field_setting
Controls whether the 「Force SSL」 section displays. This allows the page to be forced to be secure when this field exists.

input_placeholders_setting
For complex fields like the credit card, name, time, and address fields, this controls whether the 「Placeholders」 section will appear which lets you set placeholder text for the individual components of the field. When it is not a complex field, the 「placeholder_setting」 controls the display of this section.

label_setting
Controls whether the 「Field Label」 setting which allows the label to be changed appears.

rules_setting
Controls whether the 「Rules」 settings section displays. The 「Required」 option shows when this is active.

sub_labels_setting
If a field has sub-labels, controls whether the setting to set them appears.

sub_label_placement_setting
If a field has sub-labels, controls whether the 「Sub-Label Placement」 setting appears.

Properties
Below is a listing of the properties inherited from the parent class, and the properties unique to the field.

adminLabel string
The label to be used on admin pages instead of the label, useful for fields with long labels.

conditionalLogic array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

creditCards array
An array of the available credit cards for selection.
123456$creditCards = array(                 'amex',                 'visa',                 'discover',                 'mastercard'               )

creditCardStyle string
The style of the credit card icon. The values are style1 (Standard) or style2 (3D).

cssClass string
The custom CSS class or classes to be added to the input tag for the field.

description string
The field description.

descriptionPlacement string
The placement of the field description. The description may be placed 「above」 or 「below」 the field inputs. If the placement is not specified, then the description placement setting for the Form Layout is used.

errorMessage string
The custom error message to be displayed if the field fails validation.

forceSSL boolean
Indicates whether the page the credit card field is on must be secure.

formId integer
The form ID.

id integer
The field ID.

inputs array
An array containing the the individual properties for each element of the credit card field.

id integer
The id of the input field.

label string
The label for the input.

customLabel string
The custom label for the input. When set, this is used in place of the label. The expiration month and year use one label and the custom label will be stored in the array with the data for the month.

defaultLabel string
This property is only used for the month, and specifies the default label that is used as the header for the Month/Year drop downs.

placeholder string
Placeholder text to give the user a hint on how to fill out the field. This is not submitted with the form.

123456789101112131415161718192021222324252627282930313233343536$inputs = array(            array(              'id'          => '1.1',              'label'       => 'Card Number',              'customLabel' => 'Number',              'placeholder' => 'Enter your credit card number',            ),            array(              'id'           => '1.2_month',              'label'        => 'Expiration Month',              'defaultLabel' => 'Expiration Date',              'customLabel'  => 'Expiry',              'placeholder'  => 'Enter the expiration month',            ),            array(              'id'          => '1.2_year',              'label'       => 'Expiration Year',              'placeholder' => 'Enter the expiration year',            ),            array(              'id'           => '1.3',              'label'        => 'Security Code',              'customLabel'  => 'CVV',              'placeholder'  => 'Enter your CVV',            ),            array(              'id'          => '1.4',              'label'       => 'Card Type',            ),            array(              'id'           => '1.5',              'label'        => 'Cardholder Name',              'customLabel'  => 'Name',              'placeholder'  => 'Enter your name as it appears on the card',    ),)

isRequired boolean
Marking the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.

label string
The field label that will be displayed on the form and on the admin pages.

subLabelPlacement string
The placement of the labels for the fields (credit card number, expiration, security code, name) within the credit card group. This setting controls all of the credit card pieces, they cannot be set individually. They may be aligned above or below the inputs. If this property is not set, the 「Sub-Label Placement」 setting on the Form Settings->Form Layout page is used. If no setting is specified, the default is above inputs.

type string
The field type, which in this case is creditcard.

Hooks
The following hooks are located in GF_Field_CreditCard:

gform_payment_methods
gform_card_number
gform_card_expiration
gform_card_security_code
gform_card_name

Source Code
The source code is located in includes/fields/class-gf-field-creditcard.php in the Gravity Forms folder of your sites plugins directory.

GF_Field_Page

GF_Field_Page

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Page class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Page field is rendered in the form editor. This only handles the section called 「PAGE BREAK」, not the 「START PAGING」 or 「END PAGING」 sections.
Settings and Properties
Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.
Properties contain the values specified by the settings and generally are part of the Field Object.
The properties may be retrieved by accessing the Field Object as follows:
12345//get the field$field = GFFormsModel::get_field( $form, 1 ); //get the type$type = $field->type;
Settings
The following settings are available for the field:

conditional_logic_nextbutton_setting
Determines whether the 「Enable Next Button Conditional Logic」 section displays in the 「PAGE BREAK」 settings. This allows logic to be applied to control whether the 「Next」 button is displayed or hidden.

conditional_logic_page_setting
Determines whether the 「Enable Page Conditional Logic」 section displays in the 「PAGE BREAK」 settings. This allows logic to be applied to control whether the page is displayed or hidden.

css_class_setting
Controls whether the 「Custom CSS Class」 setting displays. This allows a custom css to be used for the field.

next_button_setting
Determines whether the 「Next Button」 section displays in the 「PAGE BREAK」 settings. This section allows different text or a custom image to be used for the button.

previous_button_setting
Determines whether the 「Previous Button」 section displays in the 「PAGE BREAK」 settings. This section allows different text or a custom image to be used for the button.

Properties
Below is a listing of the properties inherited from the parent class and ones specific to the field:

displayOnly boolean
Indicates the field is only displayed and its contents are not submitted with the form/saved with the entry. This is set to true.

formId integer
The form ID.

id integer
The field ID.

nextButton array
An array containing the the individual properties for the 「Next」 button.

type string
The type of 「button」 displayed. This may be 「text」 or 「image」.

text string
The text that displays on the button when it is not set to an image.

imageUrl string
The path to the image to be used for the button when the type is set to 「image」.

conditionalLogic array
The conditional logic rules that are to be applied to the 「Next」 button.
123456$next_button = array(                 'type'             => 'text',                 'text'             => 'Next Page',                 'imageUrl'         => '',                 'conditionalLogic' => array())

pageNumber integer
The page number of the current page.

previousButton array
An array containing the the individual properties for the 「Previous」 button.

type string
The type of 「button」 displayed. This may be 「text」 or 「image」.

text string
The text that displays on the button when it is not set to an image.

imageUrl string
The path to the image to be used for the button when the type is set to 「image」.
12345$previous_button = array(                     'type'     => 'image',                     'text'     => '',                     'imageUrl' => 'wp-content/uploads/2016/02/12493815_1539502326378360_2030773273496389484_o.jpg',)

type string
The field type. This is set to 「section」.

Source Code
The source code is located in includes/fields/class-gf-field-page.php in the Gravity Forms folder of your sites plugins directory.

gf_do_action()

gf_do_action()

DescriptionUsageParametersExamplesSinceSource Code

Description

Gravity Forms pre-processing for do_action.

Allows additional actions based on form and field ID to be defined easily.

Usage

1gf_do_action( array( 'my_action_hook', $form_id ), $arg1, $arg2 );

Parameters

$action arrayArray containing the action hook as well as the modifier.

Examples

1gf_do_action( array( 'my_action_hook', $form_id ), $arg1, $arg2 );

Since

This function was added in Gravity Forms version 1.9.12.

Source Code

This action hook is located in gravityforms.php

GF_Field_Textarea

GF_Field_Textarea

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Textarea class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Paragraph Text (textarea) field is rendered when the form is displayed and how its value is handled during and after form submission.
Settings and Properties
Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.
Properties contain the values specified by the settings and generally are part of the Field Object.
The properties may be retrieved by accessing the Field Object as follows:
//get the field
$field = GFFormsModel::get_field( $form, 1 );

//get the admin label
$admin_label = $field->adminLabel;

Settings
The following settings are available for the field:

admin_label_setting
Controls whether the 「Admin Field Label」 setting appears.

conditional_logic_field_setting
Controls whether the 「Enable Conditional Logic」 setting appears.

css_class_setting
Controls whether the 「Custom CSS Class」 setting displays. This allows a custom css to be used for the field.

default_value_textarea_setting
Controls whether the 「Default Value」 setting displays. This allows default text to be shown in the textarea. If this text is not changed, it will be submitted with the form.

description_setting
Controls whether the 「Description」 setting appears. This allows a description for the field to be displayed.

duplicate_setting
Controls whether the 「No Duplicates」 setting displays within the 「Rules」 section. This controls whether the same value may exist more than once in the database. The 「Rules」 setting must be active for this to display.

error_message_setting
Controls whether the 「Custom Validation Message」 setting which allows a custom message to be used appears.

label_setting
Controls whether the 「Field Label」 setting which allows the label to be changed appears.

maxlen_setting
Controls whether the 「Maximum Characters」 setting displays. This controls how many characters are allowed to be entered into the field. This is currently used by the text, textarea, post content, and post excerpt fields.

placeholder_textarea_setting
Controls whether the 「Placeholder」 setting displays. This allows a hint to be provided as to what should be entered into the field. This text is not submitted with the form. If the Rich Text Editor is being used, this setting cannot be used.

prepopulate_field_setting
Controls whether the 「Allow field to be populated dynamically」 setting appears.

rich_text_editor_setting
Controls whether the 「Use the Rich Text Editor」 setting displays. If checked, the rich text editor provides an interface which allows advanced editing/formatting capabilities to the field.

rules_setting
Controls whether the 「Rules」 settings section displays. The 「Required」 option shows when this is active.

size_setting
Controls whether the 「Field Size」 setting displays. This controls the size of the input field for fields to which it applies. The sizes are 「small」, 「medium」, and 「large」.

visibility_setting
Controls whether the 「Visibility」 setting displays. The controls whether the option of visibility being for 「Everyone」 or 「Admin Only」 can be set.

Properties
Below is a listing of the properties inherited from the parent class and ones specific to the Textarea field.

adminLabel string
The label to be used on admin pages instead of the label, useful for fields with long labels.

adminOnly boolean
Determines whether the field is visible to the user submitting the form, or only visible in the admin.

allowsPrepopulate boolean
Determines if the field values can be dynamically populated. Default is false.

conditionalLogic array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

cssClass string
The custom CSS class or classes to be added to the input tag for the field.

description string
The field description.

descriptionPlacement string
The placement of the field description. The description may be placed 「above」 or 「below」 the field inputs. If the placement is not specified, then the description placement setting for the Form Layout is used.

errorMessage string
The custom error message to be displayed if the field fails validation.

formId integer
The form ID.

id integer
The field ID.

inputName string
The parameter name used when dynamically populating the field.

isRequired boolean
Marking the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.

label string
The field label that will be displayed on the form and on the admin pages.

labelPlacement string
The placement of the main field label 「Time」. The choices are top-aligned (top_label), left-aligned (left_label), right-aligned (right_label). To control the sub-label placement of the fields within the time group, use the 「subLabelPlacement」 property.

maxLength string
The number of characters that the textarea is allowed to contain.

noDuplicates boolean
Determines if the value entered by the user may already exist in the database.

size string
Controls the width of the input field. The choices are 「small」, 「medium」, and 「large」.

type string
The field type, which in this case is textarea.

useRichTextEditor boolean – Indicates whether the field uses the rich text editor interface.

Source Code
The source code is located in includes/fields/class-gf-field-textarea.php in the Gravity Forms folder of your sites plugins directory.

GF_Field_HTML

GF_Field_HTML

IntroductionSettings and PropertiesSettingsProperties$entry ValueHooksSource Code

Introduction
The GF_Field_HTML class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the HTML field is rendered when the form is displayed and how its value is handled during and after form submission.
Settings and Properties
Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.
Properties contain the values specified by the settings and generally are part of the Field Object.
The properties may be retrieved by accessing the Field Object as follows:
12345//get the field$field = GFFormsModel::get_field( $form, 1 ); //get the html content$content = $field->content;
Settings
The following settings are available for the field:

conditional_logic_field_setting
content_setting
css_class_setting
disable_margins_setting
label_setting

Properties
Below is a listing of the properties inherited from the parent class and ones specific to the field.

conditionalLogic array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

content string
The HTML/text that displays for the field.

cssClass string
The custom CSS class or classes to be added to the input tag for the field.

disableMargins boolean
Indicates whether the default margins are turned on to align the HTML content with other fields.

displayOnly boolean
Indicates the field is only displayed and its contents are not submitted with the form/saved with the entry. This is set to true.

formId integer
The form ID.

id integer
The field ID.

label string
The field label that will be displayed on the form and on the admin pages.

type string
The field type. This is set to 「html」.

$entry Value
The HTML field is a display only field so does not save a value in the entry.
Hooks
There are no hooks located in GF_Field_HTML.
Source Code
The source code is located in includes/fields/class-gf-field-html.php in the Gravity Forms folder of your sites plugins directory.

Getting Started: A Checklist for the New User

Getting Started: A Checklist for the New User

Welcome To Gravity Forms!The BasicsExpanding Further

Welcome To Gravity Forms!
Getting started with Gravity Forms is a simple process, but there are a few steps you need to take. If you』re already familiar with installing WordPress plugins, you』re already ahead of the game.
In this article we have a checklist of the things you will need to do from the first moment you decide to use Gravity Forms, and links to a selection of the articles that can help you do it!
The Basics

Review our system requirements.
Purchase and pay for a Gravity Forms license key, which will then add your new license key to your Gravity Forms account. If you need to try out some functionality first, you can experiment with our fully functional online demo.
Download the Gravity Forms plug-in from your account.
Install the Gravity Forms plug-in.
Enter your license key into your plugin Settings to validate your installation of Gravity Forms.
Create your first form, and then start testing it out in the preview view, or add it to your test site and experiment!

You are up and running!
Expanding Further
Next steps or areas you might be interested in could include:

setting up notifications and confirmations.
reviewing your form submission, which Gravity Forms calls entries.
experimenting with more advanced fields.
extend your capabilities with our official add-ons or our community contributed third party add-ons!

Whatever you might need for your sites, Gravity Forms (and our online documentation) can help!

GF_Field_Section

GF_Field_Section

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Section class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Section field is rendered when the form is displayed and how its value is handled during and after form submission.
Settings and Properties
Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.
Properties contain the values specified by the settings and generally are part of the Field Object.
The properties may be retrieved by accessing the Field Object as follows:
//get the field
$field = GFFormsModel::get_field( $form, 1 );

//get the description
$description = $field->description;

Settings
The following settings are available for the field:

conditional_logic_field_setting
Controls whether the 「Enable Conditional Logic」 setting appears.

css_class_setting
Controls whether the 「Custom CSS Class」 setting displays. This allows a custom css to be used for the field.

description_setting
Controls whether the 「Description」 setting appears. This allows a description for the field to be displayed.

label_setting
Controls whether the 「Field Label」 setting which allows the label to be changed appears.

visibility_setting
Controls whether the 「Visibility」 setting displays. The controls whether the option of visibility being for 「Everyone」 or 「Admin Only」 can be set.

Properties
Below is a listing of the properties inherited from the parent class and ones specific to the field.

adminOnly boolean
Determines whether the field is visible to the user submitting the form, or only visible in the admin.

conditionalLogic array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

cssClass string
The custom CSS class or classes to be added to the input tag for the field.

description string
The field description.

displayOnly boolean
Indicates the field is only displayed and its contents are not submitted with the form/saved with the entry. This is set to true.

formId integer
The form ID.

id integer
The field ID.

label string
The field label that will be displayed on the form and on the admin pages.

type string
The field type. This is set to 「section」.

Source Code
The source code is located in includes/fields/class-gf-field-section.php in the Gravity Forms folder of your sites plugins directory.