bookmark_borderGF_Field_Email

Introduction

The GF_Field_Email class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Email 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;

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.

  • duplicate_setting
    Controls whether the “No Duplicates” setting displays within the “Rules” section. This controls whether the same value may exist more than once in the database. The “Rules” setting must be active for this to display.

  • email_confirm_setting
    Controls whether the “Enable Email Confirmation” section displays. This section allows a second email field to display for confirmation, and also allows custom labels for each field.

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

  • placeholder_setting
    Controls whether the “Placeholders” section appears. This allows placeholder text to display for the field.

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

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

  • 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 the properties unique 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.

  • 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 default value displayed in the field. This will be submitted with the form if not changed. If the “Enable Email Confirmation” option is checked, this property is not used. The “defaultValue” property that is part of the “inputs” array is used.

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

  • emailConfirmEnabled boolean

    Determines whether the Confirm Email field is active.

  • 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. The value will populate the Email field and the Confirm Email field if it is active.

  • inputs array

    This array only exists when the Enable Email Confirmation (emailConfirmEnabled = true) option is checked. This array contains the individual properties for each element of the email and confirm email fields.

    • id integer

      The id of the input field.

    • label string

      The label for the input.

    • customLabel string

      The custom label for the input. When set, this is used in place of the label.

    • placeholder string

      Placeholder text to give the user a hint on how to fill out the field. This is not submitted with the form.

    • defaultValue string

      The default value to be displayed in the input field.

$inputs = array(
            array(
              'id'           => '1',
              'label'        => 'Email',
              'customLabel'  => 'Email Address',
              'placeholder'  => 'Enter your email address',
              'defaultValue' => ''
            ),
            array(
              'id'           => ' 1.2',
              'label'        => 'Confirm Email',
              'customLabel'  => 'Confirm Email Address',
              'placeholder'  => 'Enter your email address again',
              'defaultValue' => ''
            )
          );
  • 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.

  • noDuplicates boolean

    Determines if the value entered by the user may already exist in the database.

  • placeholder string

    Placeholder text to give the user a hint on how to fill out the field. This is not submitted with the form. If the “Enable Email Confirmation” option is checked, this property is not used. The “placeholder” property that is part of the “inputs” array is used.

  • size string

    Controls the width of the input field. The choices are “small”, “medium”, and “large”.

  • subLabelPlacement string

    The placement of the labels for the email and confirm email fields. This setting controls both pieces, they cannot be set individually. They may be aligned above or below the inputs. If this property is not set, the “Sub-Label Placement” setting on the Form Settings->Form Layout page is used. If no setting is specified, the default is above inputs. This is only available when the Enable Email Confirmation setting is checked.

  • type string

    The field type, which in this case is email.

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