IntroductionSettings and PropertiesSettingsPropertiesSource Code
Introduction
The GF_Field_Price 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 a 「User Defined Price」 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:
conditional_logic_field_setting
Controls whether the 「Enable Conditional Logic」 setting appears.
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.
placeholder_setting
Controls whether the 「Placeholders」 section appears. This allows placeholder text to display for 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」.
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.
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.
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 price. 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.
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.
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. The type is set to 「product」. The 「inputType」 is set to 「price」.
Source Code
The source code is located in includes/fields/class-gf-field-price.php in the Gravity Forms folder of your sites plugins directory.