Summary
The Consent field allows you to offer a “yes/no” consent checkbox and a detailed description of what is being consented to. It is available under the Advanced Fields section within the form editor.
Consent field as displayed in the Field Library
Consent field as displayed in the Form Editor.
When an entry is submitted, the consent field will record the status of the consent checkbox, and if it was checked (consent was provided), then the consent title and description (as presented at the time of submission) will also be recorded. See the Entry Management section below.
This field type was introduced in Gravity Forms 2.4.
Common Settings
This field uses only common field settings for the Appearance and Advanced settings. For a description of each of the common field settings, refer to this article. Below you will find description of specialty settings that are particular to this field.
General Settings
| Setting | Description |
|---|---|
| Checkbox Label | This option allows you to specify the text the user will see next to the consent checkbox. |
Details
- HTML can be included in the consent description.
- The value of the consent description will not be displayed with the {all_fields} merge tag, but can be accessed by specifying the full input ID (i.e. {Consent:3.3}).
Entry Management
When processing an entry, the consent field will record the state of the consent checkbox (checked or not checked) . If the consent checkbox was checked, then the entry will also record the consent title and description, as was displayed at the time of form submission.
This allows you to modify the form and the details of consent, without affecting the historical record of exactly what previous submissions were agreeing to.
When displaying the entry detail, the entire consent description will be shown.
Form Revisions
Consent detail is recorded with an entry by storing the revision ID of the form that was consented to. This saves space in the entry table by reducing duplication. When displaying the entry detail though, Gravity Forms will show the entire consent description.
If you delete the form, all revision data is also deleted (along with all the entries, which is normal behavior).
Related Filters
The following filters were added to Gravity Forms in support of the consent field: