GF_Field_Shipping

• Introduction
• Settings and Properties
• Settings
• Source Code

Introduction

The GF_Field_Shipping class extends the GF_Field class, also known as the Field Object. This class is responsible for handling the Shipping field. Because Shipping fields are either a Single Method, Drop Down, or Radio Button, this class only adds some settings and sets the title for the field in the editor. The rendering of the Shipping field is handled by the class associated with its sub-type. The field “type” property will be set to “shipping” and the field “inputType” property will be “singleshipping”, “select”, or “radio”.

For more details about rendering the Option field, check out the articles below:

Drop Down – GF_Field_Select class
Radio Buttons – GF_Field_Radio class
Single Method – GF_Field_Singleshipping 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.

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

• prepopulate_field_setting
  Controls whether the “Allow field to be populated dynamically” setting appears.

• shipping_field_type_setting
  Controls whether the “Field Type” section displays. This allows the Shipping field to be set to the types: Single Method, Drop Down, Radio Button.

Source Code

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