Introduction
The GF_Field_Section class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Section 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 description
$description = $field->description;
Settings
The following settings are available for the field:
| Setting | Description |
|---|---|
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. |
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.
| Parameter | Type | Description |
|---|---|---|
adminOnly | boolean | Determines whether the field is visible to the user submitting the form, or only visible in the admin. |
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. |
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 “section”. |
Source Code
The source code is located in includes/fields/class-gf-field-section.php in the Gravity Forms folder of your sites plugins directory.