GF_Field_Name

Introduction

The GF_Field_Name class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Name 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_input_values_setting
    For complex fields like the name, time, address fields, this controls whether the “Default Values” section will appear which lets you set values for the individual components of the field. When it is not a complex field, the “default_value_setting” controls the display of this section.

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

  • name_setting
    This setting has been deprecated and is currently in the code for backwards-compatibility only.

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

  • sub_label_placement_setting
    If a field has sub-labels, controls whether the “Sub-Label Placement” setting 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 the properties unique to the Name 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.

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

    • id integer

      The id of the input field.

    • label string

      The label for the input.

    • name string

      The name of the parameter used for the input when dynamically populating the field.

    • 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/chosen in the input field.

    • isHidden boolean

      Controls whether the input is visible.

    • enableChoiceValue boolean

      Indicates whether the choice has a value, not just the text. This is only available for the Prefix field.

    • inputType string

      This is only available when it is the Prefix field and is set to “radio”.

    • choices array

      This array only exists when the Prefix field is used. It holds the prefix options that display in the drop down. These have been chosen in the admin.

      • text string

        The text that is displayed in the Prefix drop down

      • value string

        The value that is submitted with the form

      • isSelected boolean

        Indicates which item in the drop down is selected

        $inputs = array(
            array(
              'id'                => '1.2',
              'label'             => 'Prefix',
              'name'              => 'param_prefix',
              'customLabel'       => '',
              'placeholder'       => 'Select a Prefix',
              'defaultValue'      => '',
              'isHidden'          => false,
              'inputType'         => 'radio',
              'enableChoiceValue' => false,
              'choices'           => array(
                                       array(
                                         'text'       => 'Mr.',
                                         'value'      => 'Mr.',
                                         'isSelected' => false
                                       ),
                                       array(
                                         'text'       => 'Ms.',
                                         'value'      => 'Ms.',
                                         'isSelected' => true
                                       )
                                     )
              ),
            array(
              'id'          => '1.3',
              'label'       => 'First',
              'name'        => 'param_first',
              'customLabel' => 'First Name',
              'placeholder' => '',
              'defaultValue' => '',
              'isHidden'    => false
            ),
            array(
              'id'           => '1.4',
              'label'        => 'Middle',
              'name'         => '',
              'customLabel'  => 'Middle Initial',
              'placeholder'  => 'Enter your middle initial',
              'defaultValue' => '',
              'isHidden'     => false
            ),
            array(
              'id'           => '1.6',
              'label'        => 'Last',
              'name'         => 'param_last',
              'customLabel'  => 'Last Name',
              'placeholder'  => '',
              'defaultValue' => '',
              'isHidden'     => false
            ),
            array(
              'id'          => '1.8',
              'label'       => 'Suffix',
              'name'        => '',
              'customLabel' => '',
              'placeholder' => '',
              'defaultValue' => '',
              'isHidden'     => true
            ),
          );

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

  • nameFormat string

    The format of the name field. Originally, the name field could be a “normal” format with just First and Last being the fields displayed or an “extended” format which included prefix and suffix fields, or a “simple” format which just had one input field. These are legacy formats which are no longer used when adding a Name field to a form. The Name field was modified in a way which allows each of the components of the normal and extended formats to be able to be turned on or off. The nameFormat is now only “advanced”. Name fields in the previous formats are automatically upgraded to the new type if the form field is modified in the admin. The code is backwards-compatible and will continue to handle the “normal”, “extended”, “simple” formats for fields which have not yet been upgraded.

  • 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 fields (prefix, first, last, suffix, etc.) within the name group. This setting controls all of the name 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 name.

Source Code

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