GF_Field_SingleShipping

Introduction
Settings and Properties
Settings
Properties
Source Code

Introduction

The GF_Field_SingleShipping class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Single Method Shipping 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:

Setting	Description
`base_price_setting`	Determines whether the “Price” section displays. This allows a base price to be specified for shipping.

Properties

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

Parameter	Type	Description
`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 shipping price. The value includes the formatting characters.
`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.
`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. This is set to singleshipping. The type property will be set to shipping.
`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 shipping. The inputType property is set to singleshipping.

Source Code

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