bookmark_borderGF_Field_Checkbox

Introduction

The GF_Field_Checkbox class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Checkbox field is rendered when the form is displayed and how its value is handled during and after form submission. This class also handles the Product Option field rendering when it is a checkbox.

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.

  • choices_setting
    Determines whether the “Choices” setting displays. This section allows you to create different checkbox selections 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 checkboxes. Without this section, the checkboxes are limited to “First Choice”, “Second Choice” and “Third Choice” and may not be changed in the editor.

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

  • error_message_setting
    Controls whether the “Custom Validation Message” setting which allows a custom message to be used appears.

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

  • rules_setting
    Controls whether the “Rules” settings section displays. The “Required” option shows when this is active.

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

  • adminLabel string

    The label to be used on admin pages instead of the label, useful for fields with long labels.

  • adminOnly boolean

    Determines whether the field is visible to the user submitting the form, or only visible in the admin.

  • allowsPrepopulate boolean

    Determines if the field values can be dynamically populated. Default is false.

  • choices array

    An array containing the the individual properties for each checkbox.

    • text string

      The text that is displayed for the checkbox

    • value string

      The value that is used for the checkbox when the form is submitted.

    • isSelected boolean

      Indicates whether the checkbox is selected/checked

    • price string

      Used when the checkbox is an “option” field belonging to a product and contains the item price.

      $choices = array(
                   array(
                     'text'       => 'First Choice',
                     'value'      => 'one',
                     'isSelected' => false,
                     'price'      => '$5.00' //only populated if a product option field
                   ),
                   array(
                     'text'       => 'Second Choice',
                     'value'      => 'two',
                     'isSelected' => true,
                     'price'      => ''
                   ),
                   array(
                     'text'       => 'Third Choice',
                     'value'      => 'three',
                     'isSelected' => false,
                     'price'      => ''
                   ),
                 );
      

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

  • defaultValue string

    The checkbox to be checked. This must match to a value for one of the items. This is only available when the checkbox is a product option 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.

  • enableChoiceValue boolean

    Indicates whether the “show values” option within the “Choices” section of the editor is checked.

  • enablePrice boolean

    This property is used when the checkbox is a product option field and will be set to true. If not associated with a product, then it is false.

  • errorMessage string

    The custom error message to be displayed if the field fails validation.

  • formId integer

    The form ID.

  • id integer

    The field ID.

  • inputName string

    The parameter name used when dynamically populating the field.

  • inputs array

    An array containing the the individual properties for each checkbox.

    • id integer

      The id of the input field.

    • label string

      The label for the input.

      $inputs = array(
                  array(
                    'id'    => '1.1',
                    'label' => 'First Choice',
                  ),
                  array(
                    'id'    => '1.2',
                    'label' => 'Second Choice',
                  ),
                  array(
                    'id'    => '1.3',
                    'label' => 'Third Choice',
                  ),
                );
      

  • inputType string

    Used when the field has a sub-type. For instance, when the checkbox is a product option field, then the “type” is set to “option” and the “inputType” is set to “checkbox”. When the field is created, the type is initially set using the “type” property. If “inputType” is not empty, then the “inputType” is used to create the field instead.

  • isRequired boolean

    Marking the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.

  • label string

    The field label that will be displayed on the form and on the admin pages.

  • productField integer

    The id of the product field to which the checkbox is associated. This is used when the checkbox is an “option” associated with a product.

  • type string

    The field type. It is normally “checkbox”, unless the checkbox is a product field option, then the type is set to “option”, with “inputType” being set to “checkbox”.

Hooks

The following hooks are located in GF_Field_Checkbox:

Source Code

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