GF_Field_Password

Introduction

The GF_Field_Password class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Password field is rendered when the form is displayed and how its value is handled during and after form submission. The Password field is not available in Gravity Forms by default. The Gravity Forms User Registration Add-on is one of the plugins which will add this field to the list of available fields.

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 password strength
$password_strength_enabled = $field->passwordStrengthEnabled;

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.
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.
input_placeholders_setting
For complex fields like the password, name, time, and address fields, this controls whether the “Placeholders” section will appear which lets you set placeholder text for the individual components of the field. When it is not a complex field, the “placeholder_setting” controls the display of this section.
label_setting
Controls whether the “Field Label” setting which allows the label to be changed appears.
password_strength_setting
Controls whether the “Enable Password Strength” section displays. This allows the minimum password strength to be set to Short, Bad, Good, or Strong.
rules_setting
Controls whether the “Rules” settings section displays. The “Required” option shows when this is active.
sub_labels_setting
If a field has sub-labels, controls whether the setting to set them appears.
sub_label_placement_setting
If a field has sub-labels, controls whether the “Sub-Label Placement” setting appears.

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.
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.
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.
errorMessage string

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

The form ID.
id integer

The field ID.

inputs array

An array containing the the individual properties for each element of the password field.

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.

An example of the array output is as follows:

$inputs = array(
            array(
              'id'          => '1',
              'label'       => 'Enter Password',
              'customLabel' => 'Password',
              'placeholder' => 'Please enter your password'
            ),
            array(
              'id'          => '1.2',
              'label'       => 'Confirm Password',
              'customLabel' => 'Confirmation',
              'placeholder' => 'Please confirm your password'
            ),
          )

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.
labelPlacement string

The placement of the main field label “Address”. The choices are top-aligned (top_label), left-aligned (left_label), right-aligned (right_label). To control the sub-label placement of the fields within the address group, use the “subLabelPlacement” property.
minPasswordStrength string

Indicates how strong the password should be. The possible values are short, bad, good, strong.
passwordStrengthEnabled boolean

Indicates whether the field displays the password strength indicator.
subLabelPlacement string

The placement of the labels for the fields (street, city, zip/postal code, etc.) within the address group. This setting controls all of the address 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.
type string

The field type, which in this case is password.

Source Code

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