The GF_Field_MultiSelect class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Multi Select 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;
The following settings are available for the field:
Controls whether the “Admin Field Label” setting appears.
Determines whether the “Choices” setting displays. This section allows you to create different selections for the multi select and set associated values to each one. It also allows you to choose from a pre-defined set of data that may be used to create the items in the list. Without this section, the drop down selections are limited to “First Choice”, “Second Choice” and “Third Choice” and may not be changed in the editor.
Controls whether the “Enable Conditional Logic” setting appears.
Controls whether the “Custom CSS Class” setting displays. This allows a custom css to be used for the field.
Controls whether the “Description” setting appears. This allows a description for the field to be displayed.
Determines whether the “Enable enhanced user interface” setting displays. This setting allows the Chosen jquery script to be used to add search capability to the multi select.
Controls whether the “Custom Validation Message” setting which allows a custom message to be used appears.
Controls whether the “Field Label” setting which allows the label to be changed appears.
Controls whether the “Allow field to be populated dynamically” setting appears.
Controls whether the “Rules” settings section displays. The “Required” option shows when this is active.
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”.
Controls whether the “Visibility” setting displays. The controls whether the option of visibility being for “Everyone” or “Admin Only” can be set.
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.
Determines whether the field is visible to the user submitting the form, or only visible in the admin.
Determines if the field values can be dynamically populated. Default is false.
An array containing the the individual properties for each item in the multi select.
- text string
The text that is displayed
The value that is used for the multi select when the form is submitted.
Indicates whether the item is selected
$choices = array( array( 'text' => 'First Choice', 'value' => 'one', 'isSelected' => false ), array( 'text' => 'Second Choice', 'value' => 'two', 'isSelected' => true ), array( 'text' => 'Third Choice', 'value' => 'three', 'isSelected' => false ), );
- text string
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.
The custom CSS class or classes to be added to the input tag for the field.
The field description.
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.
Indicates whether the “show values” option within the “Choices” section of the editor is checked.
Indicates whether the option to use the Chosen jquery script to add search capability to the drop down is checked.
The custom error message to be displayed if the field fails validation.
The form ID.
The field ID.
The parameter name used when dynamically populating the field. The value must match the value of an item in the multi select.
Marking the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.
The field label that will be displayed on the form and on the admin pages.
Controls the width of the input field. The choices are “small”, “medium”, and “large”.
The field type. It is set to “multiselect”.
The source code is located in includes/fields/class-gf-field-multiselect.php in the Gravity Forms folder of your sites plugins directory.