bookmark_borderGF_Field_Option

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.