Gravity Forms 文档

GF_Field_Password

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Password class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Password field is rendered when the form is displayed and how its value is handled during and after form submission. The Password field is not available in Gravity Forms by default. The Gravity Forms User Registration Add-on is one of the plugins which will add this field to the list of available fields.
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 password strength$password_strength_enabled = $field->passwordStrengthEnabled;
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.

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.

input_placeholders_setting
For complex fields like the password, 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.

password_strength_setting
Controls whether the 「Enable Password Strength」 section displays. This allows the minimum password strength to be set to Short, Bad, Good, or Strong.

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 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.

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.

inputs array
An array containing the the individual properties for each element of the password 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.

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

An example of the array output is as follows:
1234567891011121314$inputs = array(            array(              'id'          => '1',              'label'       => 'Enter Password',              'customLabel' => 'Password',              'placeholder' => 'Please enter your password'            ),            array(              'id'          => '1.2',              'label'       => 'Confirm Password',              'customLabel' => 'Confirmation',              'placeholder' => 'Please confirm your password'            ),          )

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 「Address」. 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 address group, use the 「subLabelPlacement」 property.

minPasswordStrength string
Indicates how strong the password should be. The possible values are short, bad, good, strong.

passwordStrengthEnabled boolean
Indicates whether the field displays the password strength indicator.

subLabelPlacement string
The placement of the labels for the fields (street, city, zip/postal code, etc.) within the address group. This setting controls all of the address 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 password.

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

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_Field_Option

IntroductionSettings and PropertiesSettingsSource Code

Introduction
The GF_Field_Option class extends the GF_Field class, also known as the Field Object. This class is responsible for handling the Option field. Because Option fields are either a Drop Down, Radio Button, or Checkbox, this class only adds some settings and sets the title for the field in the editor. The rendering of the Option field is handled by the class associated with its sub-type. The field 「type」 property will be set to 「option」 and the field 「inputType」 property will be 「select」, 「radio」, or 「checkbox」.
For more details about rendering the Option field, check out the articles below:
Drop Down – GF_Field_Select class
Checkboxes – GF_Field_Checkbox class
Radio Buttons – GF_Field_Radio class
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_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.

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

option_field_type_setting
Determines whether the 「Field Type」 drop down displays. This allows the type of Option field to be chosen. Current choices are 「Drop Down」, 「Checkboxes」, and 「Radio Buttons」.

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

product_field_setting
Determines whether the 「Product Field Mapping」 section displays. This allows you to select to which product field the Option is associated.

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

GF_Field_Number

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Number class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Number field is rendered when the form is displayed and how its value is handled during and after form submission. If a field is a Quantity field and Number is the chosen type of quantity, then this also handles the Quantity field.
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.

calculation_setting
Determines whether the 「Enable Calculation」 setting displays. This allows a calculation to be used for the number.

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.

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

number_format_setting
Determines whether the 「Number Format」 drop down displays. This setting allows the format of the number to be set from the choices of 「Currency」, 「9,999.99」, 「9.999,99」.

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.

range_setting
Determines whether the 「Range」 setting displays. This allows a minimum and maximum range to be set to ensure the number entered fits within the range.

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.

calculationFormula string
The formula used for the number field.

calculationRounding string
Specifies to how many decimal places the number should be rounded. This is available when enableCalculation is true, but is not available when the chosen format is 「Currency」 or if this is a Quantity field of the Number type.

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 field. If this is not changed, it is the value submitted.

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.

enableCalculation boolean
Indicates whether the number field is a calculation.

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
This property is only available if the field is the Quantity field and of the Number type. This indicates the sub-type for the Quantity field. The value will be number, with the type property set to quantity.

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.

numberFormat string
The format for the number. The choices are 「currency」, 「decimal_comma」, 「decimal_dot」.

productField integer
This is only available if it is a Quantity field of the Number type. The id of the product field to which the Quantity is associated.

rangeMax integer
The maximum number the value may be. This is not available when enableCalculation is true.

rangeMin integer
The minimum number the value may be. This is not available when enableCalculation is true.

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

type string
The field type. This is set to number, unless this field is a Quantity field that is of the Number type. In that instance, the type will be set to quantity.

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

GF_Field_Name

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Name class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Name 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_input_values_setting
For complex fields like the name, time, address fields, this controls whether the 「Default Values」 section will appear which lets you set values for the individual components of the field. When it is not a complex field, the 「default_value_setting」 controls the display of this section.

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.

input_placeholders_setting
For complex fields like the 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.

name_setting
This setting has been deprecated and is currently in the code for backwards-compatibility only.

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.

sub_label_placement_setting
If a field has sub-labels, controls whether the 「Sub-Label Placement」 setting 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 the properties unique to the Name 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.

inputs array
An array containing the the individual properties for each element of the name 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.

customLabel string
The custom label for the input. When set, this is used in place of the label.

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

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

isHidden boolean
Controls whether the input is visible.

enableChoiceValue boolean
Indicates whether the choice has a value, not just the text. This is only available for the Prefix field.

inputType string
This is only available when it is the Prefix field and is set to 「radio」.

choices array
This array only exists when the Prefix field is used. It holds the prefix options that display in the drop down. These have been chosen in the admin.

text string
The text that is displayed in the Prefix drop down

value string
The value that is submitted with the form

isSelected boolean
Indicates which item in the drop down is selected
$inputs = array(
array(
'id' => '1.2',
'label' => 'Prefix',
'name' => 'param_prefix',
'customLabel' => '',
'placeholder' => 'Select a Prefix',
'defaultValue' => '',
'isHidden' => false,
'inputType' => 'radio',
'enableChoiceValue' => false,
'choices' => array(
array(
'text' => 'Mr.',
'value' => 'Mr.',
'isSelected' => false
),
array(
'text' => 'Ms.',
'value' => 'Ms.',
'isSelected' => true
)
)
),
array(
'id' => '1.3',
'label' => 'First',
'name' => 'param_first',
'customLabel' => 'First Name',
'placeholder' => '',
'defaultValue' => '',
'isHidden' => false
),
array(
'id' => '1.4',
'label' => 'Middle',
'name' => '',
'customLabel' => 'Middle Initial',
'placeholder' => 'Enter your middle initial',
'defaultValue' => '',
'isHidden' => false
),
array(
'id' => '1.6',
'label' => 'Last',
'name' => 'param_last',
'customLabel' => 'Last Name',
'placeholder' => '',
'defaultValue' => '',
'isHidden' => false
),
array(
'id' => '1.8',
'label' => 'Suffix',
'name' => '',
'customLabel' => '',
'placeholder' => '',
'defaultValue' => '',
'isHidden' => true
),
);

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.

nameFormat string
The format of the name field. Originally, the name field could be a 「normal」 format with just First and Last being the fields displayed or an 「extended」 format which included prefix and suffix fields, or a 「simple」 format which just had one input field. These are legacy formats which are no longer used when adding a Name field to a form. The Name field was modified in a way which allows each of the components of the normal and extended formats to be able to be turned on or off. The nameFormat is now only 「advanced」. Name fields in the previous formats are automatically upgraded to the new type if the form field is modified in the admin. The code is backwards-compatible and will continue to handle the 「normal」, 「extended」, 「simple」 formats for fields which have not yet been upgraded.

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

subLabelPlacement string
The placement of the labels for the fields (prefix, first, last, suffix, etc.) within the name group. This setting controls all of the name 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 name.

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

GF_Field_MultiSelect

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_MultiSelect class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Multi Select 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.

choices_setting
Determines whether the 「Choices」 setting displays. This section allows you to create different selections for the multi select 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 items in the list. Without this section, the drop down selections are limited to 「First Choice」, 「Second Choice」 and 「Third Choice」 and may not be changed in the editor.

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.

enable_enhanced_ui_setting
Determines whether the 「Enable enhanced user interface」 setting displays. This setting allows the Chosen jquery script to be used to add search capability to the multi select.

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.

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.

choices array
An array containing the the individual properties for each item in the multi select.

text string
The text that is displayed

value string
The value that is used for the multi select when the form is submitted.

isSelected boolean
Indicates whether the item is selected
1234567891011121314151617$choices = array(           array(             'text'       => 'First Choice',             'value'      => 'one',             'isSelected' => false           ),           array(             'text'       => 'Second Choice',             'value'      => 'two',             'isSelected' => true           ),           array(             'text'       => 'Third Choice',             'value'      => 'three',             'isSelected' => 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.

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

enableEnhancedUI boolean
Indicates whether the option to use the Chosen jquery script to add search capability to the drop down is checked.

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. The value must match the value of an item in the multi select.

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.

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

type string
The field type. It is set to 「multiselect」.

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

GF_Field_List

IntroductionSettings and PropertiesSettingsPropertiesDynamic PopulationCalculations SupportConditional Logic Support$entry ValueMerge TagsUseful Methodsget_value_entry_detail()get_value_export()HooksSource Code

Introduction
The GF_Field_List class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the List field is rendered when the form is displayed and how its value is handled during and after 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:

add_icon_url_setting
Determines whether the 「Add Icon URL」 section displays. This allows a URL to be entered to point to a different image to be used for the add row icon.

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

columns_setting
Determines whether the 「Enable multiple columns」 section displays. This allows the List field to have more than the default one column, with each column having a distinct name.

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.

delete_icon_url_setting
Determines whether the 「Delete Icon URL」 section displays. This allows a URL to be entered to point to a different image to be used for the delete row icon.

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.

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

maxrows_setting
Determines whether the 「Maximum Rows」 section displays. This allows a limit to be set for how many rows may be added as the form is filled out.

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.

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
These are the properties used by the List field, which can be found in the Field Object, available to many of the hooks throughout Gravity Forms and some add-ons.

addIconUrl string
The URL of the image to be used for the add row button.

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

allowsPrepopulate boolean
Determines in the field value can be dynamically populated. Default is false.

choices array
An array containing the column labels. Only used when enableColumns is true.
$choices = array(
array(
'text' => 'Column 1',
'value' => 'Column 1',
),
array(
'text' => 'Column 2',
'value' => 'Column 2',
),
array(
'text' => 'Column 3',
'value' => 'Column 3',
),
);

Each column is an associative array containing the following properties:

text string
The text to be displayed in the column header. Required.

value string
The text to be displayed in the column header.

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 li tag that contains the field.

deleteIconUrl string
The URL of the image to be used for the delete row button.

description string
The field description.

descriptionPlacement string
The field description position. Empty when using the form defaults, a value of 『below』 to position the description below the input container, or a value of 『above』 to position the description above the input container.

enableColumns boolean
Determines if the field should use multiple columns. Default is false.

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

formId integer
The ID of the form this field is located on.

id integer
The field ID.

inputName string
The parameter name used when dynamically populating the field. Only used when allowsPrepopulate is true.

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 field label visibility. Empty when using the form defaults or a value of 『hidden_label』.

maxRows integer
The maximum number of rows the user can add to the field.

pageNumber integer
The form page this field is located on. Default is 1.

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

Dynamic Population
When dynamically populating the List field via query string or the field_values parameter of the gravityform shortcode or the gravity_form function the required format is a string e.g. col1_row1|col2_row1,col1_row2|col2_row2
An array can be used to dynamically populate the field when using the gform_field_value_parameter_name filter.
If you are using the gravity_form function and have an array it would need to be converted to a string. You can do this by first serializing the array using the php serialize function and then passing that to get_value_entry_detail() which will return the dynamic population compatible string.
Calculations Support
Unfortunately the List field can』t currently be used with calculations; we do have this on the feature request list.
Conditional Logic Support
Unfortunately you can』t configure conditional logic rules on other fields based on the List field; we do have this on the feature request list.
$entry Value
The List field value is stored in the Entry Object as a serialized string. So if you submit this:

You will find the following in the entry:
a:3:{i:0;a:3:{s:8:"Column 1";s:3:"one";s:8:"Column 2";s:3:"two";s:8:"Column 3";s:5:"three";}i:1;a:3:{s:8:"Column 1";s:1:"i";s:8:"Column 2";s:2:"ii";s:8:"Column 3";s:3:"iii";}i:2;a:3:{s:8:"Column 1";s:1:"1";s:8:"Column 2";s:1:"2";s:8:"Column 3";s:1:"3";}}
When accessing the field value in the Entry Object you will want to unserialize it like so:
$list_values = unserialize( rgar( $entry, '3' ) );
You will then have an array which contains an associative array for each row. In each array the column label will be used as the key to the value.
$list_values = array(
array(
'Column 1' => 'one',
'Column 2' => 'two',
'Column 3' => 'three',
),
array(
'Column 1' => 'i',
'Column 2' => 'ii',
'Column 3' => 'iii',
),
array(
'Column 1' => '1',
'Column 2' => '2',
'Column 3' => '3',
),
);

Merge Tags
The field merge tag available via the merge tag drop down in notifications and confirmations will return the field entry value formatted as a table when the field has columns or as an unordered list.
{[Field Label]:[field_id]} e.g. {List:3}
You can use the :url modifier to return the field value as a string which could be used in a query string e.g. {List:3:url} would return one|1|i,two|2|ii,three|3|iii.
You can also use the gform_merge_tag_filter to implement your own custom modifiers to output an individual columns values.
The {all_fields} merge tag will return an unordered HTML list or a HTML table when multiple columns are enabled.
Useful Methods
GF_Field_List inherits it』s available methods from GF_Field and overrides a few of them where necessary to provide its required appearance and functionality. Here are a few methods which can be useful when writing custom code.
get_value_entry_detail()
The get_value_entry_detail() method formats the entry value before it is used in notifications, confirmations, and the entry detail page.
Usage Examples
// if you have access to the $field object
$value = $field->get_value_entry_detail( $value );

// if you don't have access to the $field object
$value = GF_Field_List::get_value_entry_detail( $value, '', false, 'url' );

$value string
The serialized string to be formatted.

$currency string
Not relevant to this field type. Default is an empty string.

$use_text boolean
Not relevant to this field type. Default is false.

$format string
How should the returned value be formatted. Default is html. Alternatives are text or url.

$media string
Where is the value being used. Default is screen. Alternative is email.

Returns string
An unordered HTML list or a HTML table when multiple columns are enabled and the $format is set to html. A comma and pipe separated string when the $format is url. A comma separated string when the $format is text.

get_value_export()
The get_value_export() method formats the entry value before it is used in entry exports and by framework add-ons that integrate with third-party services, however, you can use it in your custom code when interacting with the Form Object, Field Object and Entry Object.
Usage Examples
// if you have access to the $field object
$value = $field->get_value_export( $entry );

// if you don't have access to the $field object
$value = GF_Field_List::get_value_export( $entry, $input_id );

$entry Entry Object
The entry from which the field value should be retrieved. Required.

$input_id string
The ID of the field for which the value should be retrieved. Required when not using $field. Defaults to the $field->id property when not supplied. To access values for a specific column you can include the column number (zero based) with the field id e.g 3.1 would return the values from the second column.

Returns string
The values for a single column returned as comma separated string. When columns are enabled and a column number is not specified the entry value will be converted to a json string.

Hooks
The following hooks are located in GF_Field_List:

gform_column_input
gform_column_input_content

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

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.

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_Hidden

IntroductionSettings and PropertiesSettingsPropertiesSource Code

Introduction
The GF_Field_Hidden class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Hidden field and the Hidden Quantity field are 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 label
$label = $field->label;

Settings
The following settings are available for the field:

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

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

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

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

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

defaultValue string
The default value to be set in the field. If this is not changed, it is the value submitted.

formId integer
The form ID.

id integer
The field ID.

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

inputType string
This property is only available if this is a hidden Quantity field. The inputType will be set to hidden, while the type will be set to quantity.

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

productField integer
This property is only available if this is a hidden Quantity field. The id of the product field to which the field is associated.

type string
The field type. This is set to 「hidden」, unless this is a hidden Quantity field, then the type will be quantity.

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