bookmark_borderGF_Field_Total

Introduction

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

  • description_setting
    Controls whether the “Description” setting appears. This allows a description for the field to be displayed.

  • label_setting
    Controls whether the “Field Label” setting which allows the label to be changed 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.

  • formId integer

    The form ID.

  • id integer

    The field ID.

  • type string

    The field type, which in this case is total.

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