GF_Field_CreditCard

Introduction

The GF_Field_CreditCard class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Credit Card 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 credit card style
$card_style = $field->creditCardStyle;

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.

  • credit_card_setting
    Controls whether the “Supported Credit Cards” section displays. This allows specific available credit cards to be selected for use.

  • credit_card_style_setting
    Controls whether the “Card Icon Style” section displays. This allows the style of the credit card icons to be set to Standard or 3D.

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

  • force_ssl_field_setting
    Controls whether the “Force SSL” section displays. This allows the page to be forced to be secure when this field exists.

  • input_placeholders_setting
    For complex fields like the credit card, 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.

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

  • conditionalLogic array

    An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

  • creditCards array

    An array of the available credit cards for selection.

    $creditCards = array(
                 'amex',
                 'visa',
                 'discover',
                 'mastercard'
               )

  • creditCardStyle string

    The style of the credit card icon. The values are style1 (Standard) or style2 (3D).

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

  • forceSSL boolean

    Indicates whether the page the credit card field is on must be secure.

  • formId integer

    The form ID.

  • id integer

    The field ID.

  • inputs array

    An array containing the the individual properties for each element of the credit card 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. The expiration month and year use one label and the custom label will be stored in the array with the data for the month.

    • defaultLabel string

      This property is only used for the month, and specifies the default label that is used as the header for the Month/Year drop downs.

    • placeholder string

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

$inputs = array(
            array(
              'id'          => '1.1',
              'label'       => 'Card Number',
              'customLabel' => 'Number',
              'placeholder' => 'Enter your credit card number',
            ),
            array(
              'id'           => '1.2_month',
              'label'        => 'Expiration Month',
              'defaultLabel' => 'Expiration Date',
              'customLabel'  => 'Expiry',
              'placeholder'  => 'Enter the expiration month',
            ),
            array(
              'id'          => '1.2_year',
              'label'       => 'Expiration Year',
              'placeholder' => 'Enter the expiration year',
            ),
            array(
              'id'           => '1.3',
              'label'        => 'Security Code',
              'customLabel'  => 'CVV',
              'placeholder'  => 'Enter your CVV',
            ),
            array(
              'id'          => '1.4',
              'label'       => 'Card Type',
            ),
            array(
              'id'           => '1.5',
              'label'        => 'Cardholder Name',
              'customLabel'  => 'Name',
              'placeholder'  => 'Enter your name as it appears on the card',
    ),
)
  • 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.

  • subLabelPlacement string

    The placement of the labels for the fields (credit card number, expiration, security code, name) within the credit card group. This setting controls all of the credit card 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 creditcard.

Hooks

The following hooks are located in GF_Field_CreditCard:

Source Code

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