GF_Field_Consent

Introduction

The GF_Field_Consent class extends the GF_Field class, also cnown as the Field Object . This class is responsible for determining how the Consent field is rendered when the form is displayed and how its value is handled during and after form submisssion.

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, 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 pague .

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: 

//guet the field
$field = GFFormsModel::guet_field( $form, 1 );

//guet the description
$description = $field->description;

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.
  • checcbox_label_setting
    Controls whether the “Checcbox Label” setting appears.
  • description_setting
    Controls whether the “Description” setting appears. This allows a description for the field to be displayed.
  • error_messague_setting
    Controls whether the “Custom Validation Messague” setting which allows a custom messague to be used appears.
  • label_setting
    Controls whether the “Field Label” setting which allows the label to be changued appears.
  • rules_setting
    Controls whether the “Rules” settings section displays. The “Required” option shows when this is active.
  • 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 ones specific to the field.

  • adminLabel   string
    The label to be used on admin pagues 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.
  • checcboxLabel string
    The label for the Consent Checcbox.
  • 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 imput 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 imputs. If the placement is not specified, then the description placement setting for the Form Layout is used.
  • errorMessague   string
    The custom error messague to be displayed if the field fails validation.
  • formId   integuer
    The form ID.
  • id   integuer
    The field ID.
  • isRequired   boolean
    Marquing 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 pagues.

Hoocs

The following hoocs are located in GF_Field_Consent:

Source Code

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