DescriptionUsageParametersExamplesSource Code
Description
Triggered after the payment details are displayed within a Gravity Forms entry.
Usage
1add_action( 'gform_payment_details', 'my_function', 10, 2 );
Parameters
$form_id integer
The current form ID.
$entry array
The current entry.
Examples
1234function my_function() { //Do something here}add_action( 'gform_payment_details', 'my_function', 10, 2 );
Source Code
This action hook is located in entry_detail.php.
DescriptionUsageParametersExamplesSource Code
Description
Triggered after the display of the update or invalid key notice for Gravity Forms.
Usage
1add_action( 'gform_updates', 'my_function', 10, 0 );
Parameters
There are not any parameters available for this action.
Examples
1234function my_function() { //Do something here}add_action( 'gform_updates', 'my_function', 10, 0 );
Source Code
This action hook is located in update.php.
2.0.12.0 | 2020-12-231.1 | 2020-05-061.0 | 2018-12-17
2.0.1
Fixed PHP 8 compatibility issues.
2.0 | 2020-12-23
Added support for 2Checkout API version 6.0.
Added support for Gravity Forms 2.5.
1.1 | 2020-05-06
Added translations for Hebrew, Hindi, Japanese, and Turkish.
Updated Javascript files to use minified versions.
Fixed an issue where the API credentials settings could show as valid when an authentication error is returned by the 2Checkout API.
1.0 | 2018-12-17
Initial release.
Pre-RequisitesSummaryNotes
Pre-Requisites
This field is only available in the Form Editor if you have installed the official Gravity Forms 2Checkout Add-On
Summary
The 2Checkout field provides Credit Card input fields tied to integrating with the 2Checkout payment service. If you have another Payment Gateway add-on installed and active, the Gravity Forms Credit Card Field is still available in case you are allowing users to choose from a list of payment processors, such as Stripe and Authorize.Net (the standard Credit Card field is needed for Authorize.Net』s processing). Conditional logic can be used to show/hide the Credit Card field depending on the payment processor selection.
2Checkout field as displayed in the Field Library
2Checkout field as displayed in the Form Editor.
This field will add the Credit Card Detail inputs for 2Checkout. The Card Details input collects the Card Number, Expiration Date, Security Code, and Cardholder Name. This part of the 2Checkout field is hosted on 2Checkout』s servers. All fields are required and are passed onto 2Checkout. You can modify the Field Label and the Description for this field.
Notes
When using Page fields to create a multi-page form, the 2Checkout field should be located on the last page of the form.
IntroductionWhat does Gravity Forms provide with a GoDaddy starter license?Can I get any help from Gravity Forms for my GoDaddy starter license?How can I see the license key for my GoDaddy Starter license?Do I have a Gravity Forms account to go with my GoDaddy license?How do I upgrade a GoDaddy starter license to a fully featured Gravity Forms license?I』ve switched my website hosting; can I transfer my GoDaddy starter license?
Introduction
All GoDaddy managed WordPress accounts include a free Gravity Forms Starter license for one year. Read more below to learn which features are and are not included.
What does Gravity Forms provide with a GoDaddy starter license?
A GoDaddy starter license provides:
– access to automatic updates and future releases of Gravity Forms (core plug-in)
– access to the normal GoDaddy support and services you are entitled to
It does not provide access to:
– official Gravity Forms add-ons
– access to Gravity Forms official support
Can I get any help from Gravity Forms for my GoDaddy starter license?
We will happily answer simple Contact Us questions and refer you to our public help documentation for questions regarding installation, updates, and how to upgrade your license, etc.
For anything more complex, such as help with setup, conflicts, debugging forms, etc, you will need to purchase a paid Gravity Forms license, which entitles you to our Priority Support service.
How can I see the license key for my GoDaddy Starter license?
A GoDaddy starter license is installed for your GoDaddy website automatically. You do not receive (nor do you need) a license key.
Do I have a Gravity Forms account to go with my GoDaddy license?
No, Gravity Forms accounts are not created for GoDaddy starter licenses, and these licenses are not linked to our account system. You would need to purchase a license from Gravity Forms in order to obtain a full Gravity Forms account.
How do I upgrade a GoDaddy starter license to a fully featured Gravity Forms license?
You can purchase directly from us but keep an eye out for special offer banners on your WordPress dashboard. These may snag you a discount on your upgrade, offered just to GoDaddy starter license customers!
I』ve switched my website hosting; can I transfer my GoDaddy starter license?
No you cannot. The Starter license is usable only on a GoDaddy hosted website. You would need to purchase a new Gravity Forms license.
Notice: In June 2017, the PayPal IPN began requiring SSL/HTTPS on all IPN callbacks. If you are using the PayPal IPN, you will need to obtain an SSL certificate. As such, this is a deprecated article left here only for historical reasons.
While an SSL certificate is a great idea in almost all use cases (especially when entering any personal information), some users may choose not to use one.
Most payment services, such as Authorize.net, require an SSL to receive payments, as the data is processed from within your site. The good news is, this is not the case for the PayPal Standard Add-On.
When submitting a payment through a form using the PayPal Standard add-on:
The user fills out the form that contains their total price.
The pricing and user is then redirected to PayPal』s website to complete the purchase.
After completion, the user and payment completion are then directed back to your website.
Using this method, no payments are being processed directly on your site, and therefore an SSL is not required. Since all sensitive information is being entered directly to PayPal, there is no need for an SSL to encrypt this sensitive data.
IntroductionFrom the Form List ScreenFrom the Form Editor Screen
Introduction
Each of your forms has its own set of settings and options that affect only that form. This is different to the global Gravity Forms Settings that affect all your forms. This article shows you how to access your form-specific settings.
From the Form List Screen
Hover over the form title you wish to change in the list.When the menu appears below the form title, click or hove over settings to expose a drop down showing Form Settings. Now you can edit the settings you need. Once you are done, don』t forget to scroll to the bottom and click Save Settings.
In this animation, we access the Form Settings from the list view, and make a small change to the form title.
From the Form Editor Screen
Hover over or click Settings in the top bar.In the drop down menu that appears, click form Settings.
In this animation, we access the Form Settings from the Form Editor, and make another edit to the form title.
IntroductionLimitationsYour WordPress ThemeGeneral SettingsForm SettingsForm Fields To AvoidField SettingsGeneralAppearanceAdvancedAdding a form to a page
Introduction
What steps do I need to take to create an accessible form with Gravity Forms?
This questions can seem daunting when you are starting work on your project. The good news is that Gravity Forms is built to comply with WCAG 2.1 AA, the global standard for web accessibility. This article takes you through a number of the settings and form fields to help educate you as to what to use (and what to avoid) to move your particular form towards the best possible outcome for all users.
This is a checklist, written as a short and easy to use way check your forms. If you want to know about the 「why」, please read the accessibility documentation in the Knowledge Base.
Limitations
This checklist is an aid to help you get your form as accessible as possible, but it is not a guarantee.
There are a number of external factors that can affect accessibility, and some areas of accessibility research differ in their views of exactly what is needed, but this article will help you lock down some of the most common settings and options that can affect accessibility. If you have strict compliance requirements, we recommend you bolster the knowledge provided in our documentation with the expertise of an accessibility consultant or advisor. That』s what we did!
Additionally, note that form elements from plug-ins are not included in this checklist, such as those added by the Gravity Forms payment add-ons.This checklist was written for Gravity Forms 2.5, and we will look to periodically update it when there are accessibility improvements or changes in the forms.
Your WordPress Theme
First a word about the WordPress theme you are using. The color contrast between the text and the background is important. Your visitors must be able to read the content in a form.
Gravity Forms ships with it』s own stylesheet (CSS). The color contrast is optimised for a white background color, but your theme may have a darker background color that makes text unreadable when you use the Gravity Forms stylesheet. Check the color contrast ratio between the text and it』s background. It is recommended that ratio be 4.5:1 or higher.
Don』t disable the whole stylesheet only for the color contrast. Remember that the CSS also controls the look and feel of the form elements and the way error messages are displayed, which can also affect accessibility.
Depending on your theme, it may be possible to adjust or overrule some of the CSS using the customizer, or in the CSS of your theme. If needed, discuss options with your site developer or contact the theme provider for advice.
General Settings
Go to the Gravity Forms settings page under Dashboard > Settings and set:
Output Default CSS: 「On」.Output HTML5: 「On」.
Form Settings
For a newly created form, go to the Form Settings tab and check the following settings that are important for accessibility:
Label Placement: 「Top aligned」Sub-Label Placement: 「Above Inputs」.Validation Summary: 「On」.Required Field Indicator: Ensure the option to show a required field indicator is selected.Form button: Choose 「Text」. Use descriptive text.Form button Conditional Logic: Do not enable conditional logicEnable legacy markup: 「Off」.
Form Fields To Avoid
The following field types can create accessibility issues, and are not recommended for use in an accessible form.
MultiselectHTML blocks with text that contains essential informationSection breaks with text that contains essential informationreCAPTCHA V2 (an accessible alternative is the honeypot option, as can be found in the form settings).
Field Settings
The form fields settings can be found in the right hand sidebar when you create or edit a form. If a setting is not mentioned here, it has no known accessibility issues.
General
Field Label: always fill out the Field label, explain clearly to the user what needs to be filled out.Input mask: do not use an input mask. Leave that box unchecked.
Appearance
Field Label Visibility: always use a visible label, never hide it.Sub-Label Placement: above input.Custom Validation message: if possible, write meaningful to-the-point custom error messages. Enhanced User Interface: do not enable the enhanced User Interface for dropdowns.Multi-File Upload: do not enable Multi-File Upload with the File Upload field. Using single file upload is ok.
Advanced
Rich text Editor: Do not enable the Rich text editor.Autocomplete: Enable autocomplete for name, address and email fields. The default fields for these fields have the autocomplete values already filled out.
Adding a form to a page
Add the block for a form to the page and select the block settings:
Form settings: enable the Form Title.Advanced settings: do not set a positive tabindex. Keep the tabindex value -1. This means that no tabindex will be set.Do not add more than one of the same form to a web page. Each form on the page must be unique.
IntroductionWhy should you make your form accessible? And what is Web Accessibility?About Guidelines and Legal ImplicationsSettings for Optimal AccessibilityGeneral SettingsForm SettingsAdding Form Block to a PageLabels, Placeholders and DescriptionsWhy?ExamplesTabindexUse of ColorHTML Blocks and Section BreaksAbout NamingGive Users an Idea About What to ExpectreCAPTCHAsForm ValidationWhat is Required?Custom Validation MessagesRecommended Resources
Introduction
With Gravity Forms you have a great tool to create accessible web forms. In this documentation we want to help you:
Set up a form with accessibility in mind.
What to look out for to safeguard the accessibility of your forms.
To help you make your forms work for as many people as possible, we give you guidelines and best practices on this page. Please read our Accessibility Checklist for Gravity Forms.
Why should you make your form accessible? And what is Web Accessibility?
With form accessibility we mean that a form is usable by as many people as possible, on as many different devices as possible.
Like:
A web developer who uses a desktop computer, keyboard and a mouse.
A blind woman who uses a desktop computer, keyboard and a screen reader.
A blind and deaf user, who uses a desktop computer, keyboard, a screen reader and a braille display.
A traveler who uses a smartphone in the train with slow WiFi.
An elderly person, who uses an iPad in bright sunlight.
A child that broke her arm and uses only the keyboard.
You can come up with a lot of ways to use the internet. The W3C listed a few user personas.
As for disabled people: the estimate is that approximately 20% of all people have some sort of disability. That』s 20% of your form users. And as the population is growing older, this number will increase.
We are all different and situations differ too. It』s not only disabled people that use the web differently than you may expect. If you make your forms accessible, all users will benefit.
To help you make your forms work for as many people as possible, we give you guidelines and best practices on this page.
If you are a theme or plugin developer, please also check the Developers Documentation on Form Accessibility.
About Guidelines and Legal Implications
For Gravity Forms we follow the global guidelines for web accessibility: the Web Content Accessibility Guidelines, version 2.1, level AA (WCAG 2.1 AA). Some countries have WCAG 2.0 AA as legal requirement or have a special set of guidelines. If you want to know which guidelines and legal regulations apply for your country and for your type of website, please consult with your government. The W3C maintains a list of regulations per country: Web Accessibility Laws & Policies.
Settings for Optimal Accessibility
General Settings
After installing go to the Forms > Settings page and set:
Output HTML5: 「On」.
Output Default CSS: 「On」.
Form Settings
After creating a new form, go to the Settings, Form Settings and set:
Label Placement: 「Top aligned
Sub-Label Placement: 「Above Inputs」.
Validation Summary: 「On」.
Required Field Indicator: Do not remove the option to show a required field indicator.
Form Button > Input Type: Choose 「Text」.
Form Button > Button Text: Use descriptive text (see 「About Naming」).
Form Button > Conditional Logic: Do not enable conditional logic.
Form Options > Enable Legacy Markup: 「Off」.
Adding Form Block to a Page
When you add the block for a form to a page, under the Block Settings set:
Form settings: Enable the Form Title.
Advanced settings: Do not set a positive tabindex. Keep the tabindex value -1. This means that no tabindex will be set.
Labels, Placeholders and Descriptions
A label tells the user what they need to fill out and must always be visible.
Place the label above or next to the input.
Keep a label about the input fields only, don』t put links or other HTML inside them.
The placeholder is used for a suggestion on how to fill out an input field.
The description can be used to give extra information about the input field.
The label should always be meaningful and visible. The placeholder and description are optional.
Why?
When the label is always visible, people don』t forget what they have to fill out.
When the form inputs are filled with autocomplete, the users can better check if the input is added to the right input field when the label stays visible.
People read from top to bottom. Placing a label below the input may cause confusion about which label belongs to which input.
When a user starts typing the placeholder disappears, so if the placeholder is used as the only label, the user can get confused on what to fill out.
If you use links inside a label, assistive technology, like a screen reader user may get confused about what to fill out, keep the label text to the point. Use the description to add extra information.
Gravity Forms makes sure that the description is also read out for people with a screen reader. Use that field to give extra information.
Examples
Label: Name
Placeholder: For example Jane Doe
Label: Date
Description: Please use format dd/mm/yyyy to enter the date.
Tabindex
Avoid using a positive tabindex on form controls.
Some users can』t use a mouse, for example because they are blind or don』t have fine motor skills. Then they can use the keyboard to navigate a website. If you use the tab key you can jump from focusable element to focusable element (like a link, button or a form element).
If you add a positive tabindex to a form element, that element will be the first that gets focus on a page. In fact you are hijacking the natural focus order. That can be very annoying for someone who is navigating the site with a keyboard and just wants to access the main menu and not subscribe to your newsletter.
Give the user control and don』t decide for them.
Use of Color
Usually the colors of your forms are determined by the WordPress theme you are using. If you want to change the colors in the customizer, please keep a few things in mind:
The color contrast between text and its background and borders and their background must be sufficient. This is explained in the Accessibility Documentation for Developers.
Don』t refer to or give meaning to color. Like: 「Press the green button to continue」.
Not everybody has perfect eyesight. By giving text and borders a good color contrast against its background, you are assured most people can find and read it, even with an iPad in the sun.
8% of all men and 0.4% of all women are color blind. They could miss the reference to the color.
HTML Blocks and Section Breaks
Make sure an HTML block or Section Break doesn』t contain content that is essential for filling out the form. Assistive technology, like a screen reader may miss this content as it』s not announced when the fill out a form.
Use the description field with an input to add essential information. As the description field will be read out for blind users by their screen readers.
About Naming
Make links, labels and buttons easy to understand on their own. Don』t let your users guess, or have to read all around a link or button to see what』s happening. Use descriptions if more information is needed to fill out an input.
For example:
Give a button a clear text. 「Submit」 is very generic. What about 「Subscribe」?
Give a link a describing text. 「Click here」 is not really useful. What about 「our privacy statement」 as link text? Write your sentences so that the link text stands out on its own, without forcing the user to read around the text to know why they should click here.
Give a clear description with a new password, like: Please enter password of more than 8 characters long.
Give Users an Idea About What to Expect
Do you have a form with multiple steps? That』s a good idea to break a long form into manageable pieces for the user. But don』t keep users in the dark about how much steps it takes to fill out a form.
If you use page breaks, also set a visible progress bar.
People with an anxiety disorder (and actually, everyone else too) will feel much more comfortable if they know what to expect. Inform users on the amount of steps. Give them a way to return to previous steps to double check if everything is filled out properly.
Give buttons and links a descriptive text so it』s clear what to expect when a user clicks a button or link.
reCAPTCHAs
Accessibility best practice: CAPTCHAs and reCAPTCHAs can be very challenging to fill out for people who are blind or have a cognitive disability or aren』t that web savvy.
Please consider if you really need them. You may need to find another way to prevent spam. Enabling the Anti-spam honeypot can be an option for your site or use a spam protector plugin.
Googles reCaptchas V3 may be an option, but also can violate the privacy of your users. It』s complicated.
First of all: don』t put the burden of preventing spam on your users, you may block real users from filling out your form.
Form Validation
What is Required?
Not all users know what the asterisk () means. So if you indicate a required fields with an asterisk (), put a line above the form with an explanation or add (required) within the label.
Custom Validation Messages
Use the Custom Validation Messages with the form inputs to provide meaningful error messages. A text like 「This field is required」 can be improved on, for example 「Please enter your full name」.
Carefully written error messages are essential. Giving informative feedback on an omission or mistake will keep user irritation to a minimum.
Give the user all the help you can offer to fill out a form, including your contact information if you really want the user to be able to fill out the form.
Recommended Resources
Website Forms usability: Top 10 recommendations
Forms that Work (book)
Designing Good Questions by GOV.UK
The Question Protocol: How to Make Sure Every Form Field is Necessary
IntroUse a visible labelThe order of elementsColour contrast of form controlsDesign clear hover and focus statesMake it easily clickable!Custom styled controls can be hardFont sizeAdditional Resources:
Intro
Design a beautiful form and and make it accessible for all users, that』s what we all want. What do you need to take into account? On this page we list some of the most important topics where design, accessibility and good UX meet.
We suggest you first read the document for Accessibility for Content Providers, as a lot of that information is also relevant to designers.
Use a visible label
As highlighted in the documentation for content providers, it is worth emphasizing again here: a visible label is required for an accessible website.
It reminds the user about what to fill out.
If the form is filled with values via autofill, the user can check easily if the information is filled out correctly.
Give the user all the help you can offer to fill out a form.
The order of elements
Visitors, and especially people using a screen reader, read from the top down. So the order of the information must be logical if you read it from the top down.
For example information placed below the submit button could stay unnoticed. Place the label above or next to the form control, not below it. A label below an input field can confuse users about which label belongs to which input field.
Colour contrast of form controls
A form control, like an input field should be recognisable. Don』t make your visitor guess where an input fields is. People are used to conventions, so no need to reinvent the wheel for an important element such as a form field, as to many breaks from generally understood conventions may introduce difficulties for some of your customers.
Give a form control like an input field clear borders, with a colour contrast of 3:1 between the control and the background.
Design clear hover and focus states
Let users clearly see the on hover or on focus states for focusable elements like buttons, input fields and links. Keyboard only users need to know when an element has focus, or else they can be easily lost on a page. Make sure the state change is not just based on a color change, as color blind people may miss that change.
Make it easily clickable!
Very small buttons are harder to target with a mouse or a finger. Make focusable elements like buttons or selects, stand out. Give them room, and make them large enough to be easily clicked.
Custom styled controls can be hard
Consult your developer when you apply complex custom styling to select fields and your options, checkboxes and radio buttons. Some styling is very hard to make accessible, and a compromise may be the best way to go.
Font size
Avoid small font sizes: stick with 16px or larger wherever possible, then everyone can read the text comfortably.
Additional Resources:
Jesse Hausler: 7 Things Every Designer Needs to Know about Accessibility
Tyler Hawkins: Designing accessible forms: the 10 foundational rules
Human Made: Accessible Design: A Process
WebAIM: Creating Accessible Forms – General Form Accessibility
