Author 诗语

Using the Akismet Add-on

IntroductionDescriptionPrerequisitesSetup AkismetMarked As SpamTesting Akismet FormsAkismet Hooks

Introduction

The official Gravity Forms Akismet Add-on provides a way to integrate your form with the Akismet service, allowing you to use that service to help identify suspicious or likely spam entries.

Description

Akismet is a spam filtering plugin for WordPress websites. It catches blog comments and pingback spam using its own algorithm and a broad collection of data collected from thousands of sources.

This algorithm learns from previous data and the actions taken by participating websites. For example, when a number of websites start reporting similar content as spam, Akismet will learn to identify this type of content as spam.

Akismet integration used to be part of Gravity Forms core but with the release of Gravity Forms, Akismet integration is now handled by the official Gravity Forms Akismet addon. Both integrations will work for the time being but the old method of integration will be phased out.

Prerequisites

To use the Akismet Add-On, you will require:

Gravity Forms plugin, and the official Gravity Forms Akismet Add-On.The Akismet Spam Protection plugin must be installed and active.Ensure the global Akismet setting under Gravity Forms → Settings page is toggled to On.

When all prerequisites are satisfied, a new Akismet page will be added to the Form Settings area of every form.

Setup Akismet

Refer to the Akismet Settings Reference article for a full list of add-on settings, and the Setting Up The Akismet Add-On for the process steps required to get up and running.

Marked As Spam

When Akismet marks an entry as spam the entry can still be found on the entries page, but it will be placed in the Spam category instead of Unread.

When you manually mark an entry as spam (by clicking the red Spam link as shown in the screenshot above) it will help train Akismet for similar entries moving forward. Akismet will take this information and uses it to improve its spam filtering process not only on your installation but across all websites. This help guide shows how to mark entries as spam.

Testing Akismet Forms

Entries submitted from a form preview will be processed by Akismet in test mode, which prevents those submissions from training the Akismet filters.Embedded forms submitted by logged in users will send the user role to Akismet. Akismet does not mark submissions by administrators as spam.

Akismet Hooks

Gravity Forms includes two filters which can be used to customize the Akismet integration:

gform_akismet_enabled which can be used to enable or disable the integration globally or for specific forms.gform_akismet_fields which can be used to modify the data which is sent to Akismet.

Using the PayPal Checkout Add-On

IntroductionPrerequisitesSetup PayPal CheckoutSetup Your FormConfiguring a FeedViewing Sales ResultsTransaction Types SupportedPayPal Checkout Add-On HooksAdd-On Framework Hooks

Introduction
The Gravity Forms PayPal Checkout Add-On, when connected to the PayPal Checkout, allows you to quickly and easily accept payments from 286 million PayPal customers, in over 100 currencies and across 200 markets, with advanced Fraud Protection and unprecedented control.
This add-on was previously named PayPal Commerce Platform at version 1.0. Note that the filters do still use the _ppcp_ naming convention, and have not been changed to avoid any issues with existing hook users.
Prerequisites
You will need Gravity Forms version 2.4 or greater and the Gravity Forms PayPal Checkout Add-On installed and activated.
Because of the secure nature of capturing payment information, you will be required to install an SSL certificate on your web site if you have not already done so. You will also need to configure your WordPress site to work properly with SSL.
Contact your web host if you need assistance purchasing and configuring an SSL certificate.
If you need assistance configuring your WordPress site to work with SSL, we recommend the Really Simple SSL Plugin.
Setup PayPal Checkout
Learn how to setup the PayPal Checkout Add-on in our Setting Up The PayPal Checkout Add-On article.
Setup Your Form
Refer to the Setting Up A PayPal Checkout Compatible Form article for detailed instructions on how to setup your form to be compatible with the PayPal Checkout Add-on.
Configuring a Feed
See the Configuring A Feed For The PayPal Checkout Add-On article.
Viewing Sales Results
After creating a feed and making your first sale, you can view the results on the Sales Results page.  Review Viewing Sales Results article for more information.
Transaction Types Supported
The PayPal Checkout Add-on supports one-time payments (aka the Products and Services transaction type) and recurring payments (Subscriptions Transaction Type). You can also configure an Authorize and Capture transaction.
PayPal Checkout Add-On Hooks
The PayPal Checkout Add-On provides hooks that can be used to modify the default functionality or extend it. For more information, review the PayPal Checkout Add-On Hooks.
Add-On Framework Hooks
Because the PayPal Checkout Add-On is built using the Add-On Framework it also inherits any hooks available in the framework methods it uses such as:
gform_{$SHORT_SLUG}_field_value for changing a field value before it is passed to the PayPal Checkout.

Using the Polls Add-On

Pre-RequisitesIntroductionSetup Your Poll FormAdding a Poll to your SiteDisplaying Your Poll Results

Pre-Requisites

Setting up the Polls the Add-On

Introduction

The Gravity Forms Polls Add-On allows you to quickly and easily deploy Polls on your website using the power of Gravity Forms. The Polls Add-On allows you to add fields to your form that ask users questions, capture their response, and show them the results of the poll when the form is submitted.

Polls are a great way to interact with your users and receive instant feedback. With the Gravity Forms Polls Add-On you are not limited to just a single poll question. You can add as many Poll Fields to your form as you』d like.

Setup Your Poll Form

This article reviews setting up a Poll Form in the Form Editor.

Adding a Poll to your Site

There are a few different ways you can add your already-configured poll to your page or post.

using a shortcodeusing a Poll Block, chosen from within WordPress block editor. See this article.using a Poll Widget to insert the poll into your sidebar in site themes that support it. Refer to this WordPress page on widgets.

This article provides an in-depth example of adding a poll to your WordPress website.

Additionally, you can use the Poll specific merge tags to display poll fields or results, or just a standard Gravity Form block and choose a poll form.

Due to the way they are implemented, each presentation option may not offer the full suite of settings. For most use cases, the Poll Block is the best option, as it has a full suite of controls and a variety of display options. See the article linked below for some more details.

Displaying Your Poll Results

You have a few options on how you display poll results to site visitors and poll submitters, depending on the method you used to insert the poll on your page. Refer to the article Displaying your poll results to visitors for details.

Using the reCAPTCHA Add-On

IntroductionPre-RequisitesSetupBehaviorReviewing Spam EntriesNotesMore info

Introduction

The official Gravity Forms reCAPTCHA Add-On brings Google』s reCAPTCHA v3 technology as an addition to your anti-spam toolbox.

V3 was introduced to try and capitalize on the evolving technology of spam and bot detection that Google had implemented, and to try and make the reCAPTCHA experience as frictionless as possible by not interrupting the user. As stated by Google, reCAPTCHA v3:

…return(s) a score to tell you how suspicious an interaction is and eliminating the need to interrupt users with challenges at all. reCAPTCHA v3 runs adaptive risk analysis in the background to alert you of suspicious traffic while letting your human users enjoy a frictionless experience on your site. Google Blog post, October 2018

Pre-Requisites

This add-on requires Gravity Forms 2.5 or higher. You will need reCAPTCHA v3 keys generated by Google. reCAPTCHA technology requires Javascript to be enabled in the user』s browser. 

Setup

Instructions for setup are covered in this article.

The reCAPTCHA v2 settings previously provided in Gravity Forms core are consolidated into this settings area as well.

Behavior

With reCAPTCHA v3 correctly enabled on the site with valid keys, various actions are noted and sent to Google for them to try and identify possible spam or bot activity. This processing is done on Google』s servers, and the result is the assignment of a score to the activity. reCAPTCHA v3 returns a score, where 1.0 is very likely a good interaction, 0.0 is very likely a bot.

Note that all well-formed entries are accepted when submitted, and the Google reCAPTCHA score that is generated with that interaction is stored with the entry. Gravity Forms will compare that score to the threshold established in your settings, and if the entry is less than or equal to that threshold, the entry will be sent to spam.

When using reCAPTCHA v3, you no longer need to add a reCAPTCHA field to your form (that field applies to v2 implementations only). The v3 integration ensures that it is automatically enabled on all forms unless it is disabled in the form settings of an individual form.

Reviewing Spam Entries

You can review entries that were marked as spam by following the directions provided in this article.

Notes

Does not affect older reCAPTCHA functionality as previously provided in Gravity Forms. Both can exist on the same page if necessary.Works with multi-page forms. reCAPTCHA does not process submissions submitted from the form preview.Use of this Google service requires the sending of user behavior information from all your site pages to Google for evaluation. You should be familiar with the implications here, and review applicable privacy policy and terms and conditions. Additionally, you are required to display those policies to your users, which is handled with the reCAPTCHA badge.

More info

Google』s developer documentationGoogle』s reCAPTCHA FAQ

Using the Signature Add-On

IntroductionPre-RequisitesConfiguring the Signature FieldEntry DetailsHow Does It Work?

Introduction
The Signature Add-On for Gravity Forms allows you to capture signatures online by allowing users to sign your forms using touchscreen devices, touch pads, or a mouse by adding a new field to the Advanced Fields toolbox in the Form Editor.
Quickly and easily integrate signature capabilities into your forms without the end user having to install any special browser plugins.
With the Gravity Forms Signature Add-On you can provide a very simple user interface for allowing users to sign your forms online. It captures signature information as it is drawn and sends data to your web server where this information is converted into a PNG image and stored on your server. This happens on-the-fly as soon as the user signs the field canvas.
The Signature Add-On works on all major desktop and mobile browsers. This includes IE, FireFox, Safari, Chrome, Opera, iOS, Android, Blackberry, and WebOS.
Pre-Requisites
Setup the Signature Add-On
Configuring the Signature Field
After installing the Signature Add-On you will see a new field type added to the Advanced Fields toolbox in the Form Editor when creating or editing a Gravity Form.

In your WordPress admin dashboard, go to New Form under the Forms navigation or edit an existing form from Forms.
Add a Signature field to your form from the Advanced Fields toolbox.
Edit this new Signature field and configure the field options to your liking. Under Appearance you can change the color, size, background, border, and style.
Save your form.
Capture signatures!

Entry Details
When you view the Entry Details for a Form Entry that contains a Signature field, you will see the signature included in the entry details. The signature will be presented as a thumbnail image and you can click on the thumbnail to see the full size version of the signature itself.
For security reasons it is not automatically included as part of the {all_fields} merge tag output. You can include signatures in your email notifications by inserting the merge tag for your Signature field in the message of your notification.
How Does It Work?
The Gravity Forms Signature Add-On is powered by the well established signature capture software SuperSignature. The SuperSignature technology and source code has been licensed by rocketgenius, inc. for redistribution as an official Gravity Forms Add-On.

Using the Square Add-On

IntroductionPrerequisitesSetup SquareSetup Your FormSetting up a Square FeedViewing Sales ResultsImportant NotesSquare Add-On HooksAdd-On Framework Hooks

Gravity Forms and Square are offering a 「Free Processing Promotion」 for new Square customers that can save you credit card fees for up to 180 days. Go here for details.
Introduction
The official Gravity Forms Square Add-On allows you to quickly and easily capture one-time credit card payments with WordPress and your Square account.
Prerequisites

You will of course need Gravity Forms and the official Gravity Forms Square Add-On installed and activated.
SSL Certificate Installed and Configured
A Square account (a Square Sandbox account is also recommended, but optional)

Because of the secure nature of capturing credit card information, you will be required to install an SSL certificate on your web site if you have not already done so. You will also need to configure your WordPress site to work properly with SSL.
Contact your web host if you need assistance purchasing and configuring an SSL certificate.
If you need assistance configuring your WordPress site to work with SSL, we recommend the WordPress HTTPS (SSL) Plugin which you can find here: http://wordpress.org/extend/plugins/wordpress-https/
Setup Square
Learn how to setup the Square Add-on in our Setting Up the Square Add-on article.
Setup Your Form
Refer to the Setting up a Square Compatible Form article for detailed instructions on how to setup your form to be compatible with the Square Add-on.
Setting up a Square Feed
Now that you have configured the Square Add-on to work with your Square account, and you have a form configured, it』s time to bring it all together by configuring the form to send it』s submissions to Square. Just like all of our Gravity Forms Add-ons, this is done by creating a feed.
Review our Creating a Feed for the Square Add-on article for step-by-step instructions.
Viewing Sales Results
After creating a feed and making your first sale, you can view the results on the Sales Results page.  Review Viewing Sales Results article for more information.
Important Notes

The currency setting for your Square Account must match your Gravity Forms Currency Setting. if not matched, you will get an error when you attempt to connect to your Square account.

Square Add-On Hooks
The Square Add-On provides hooks that can be used to modify the default functionality or extend it. For more information, review the Square Add-On Hooks.
Add-On Framework Hooks
Because the Square Add-On is built using the Add-On Framework it also inherits any hooks available in the framework methods it uses such as:
gform_{$SHORT_SLUG}_field_value for changing a field value before it is passed to Square.

Using the Survey Add-On

IntroductionPre-RequisitesConfiguring the Survey FieldDisplay Your SurveySurvey ResultsSurvey Merge Tags

Introduction

The Survey Add-On allows you to easily interact with your users to both collect and analyze data on your target audience. Market research, customer satisfaction, employee surveys, job satisfaction surveys – anything is possible! You can even implement Survey fields on an Order Form to quickly get feedback from your customers as they place an order!

The Survey field introduces not one, but three new field types geared towards surveys: Likert, Rating, and Rank. The Survey field is accessible in the Form Editor within the Advanced Fields toolbox.

The integrated Survey Results display allows you to view your survey results and filter the results data based on your needs. You can view Survey Results for any form that contains a Survey field by clicking on the Results link on the Gravity Forms toolbar.

Pre-Requisites

Setup the Survey Add-On

Configuring the Survey Field

After installing and activating the Survey Add-On, you can now add Survey fields to your form. This is done by adding a Survey field from the Advanced Fields toolbox in the form editor to any form you would like to add a Survey to. You would add a Survey field for each survey question you would like to ask the user.

In your WordPress admin dashboard, go to New Form under the Forms navigation or edit an existing form from Forms.Add a Survey field to your form from the Advanced Fields toolbox.Edit the field and configure the options. You can configure it as a Likert, Rank, Rating, Radio Buttons, Checkboxes, Single Line Text, Paragraph Text, or Drop Down field using the Survey Field Type option.Enter the survey question in the Survey Question box.Enter the answer choices in the Choices interface based on which Survey Field Type you selected.Save your form.

That』s it! Creating a Survey using Gravity Forms is that easy.

Display Your Survey

The Gravity Forms Survey Add-On uses the standard form shortcode, function, and widget in order to display the form. You would insert your survey into a page or post using the standard methods you already use when displaying a Gravity Form on your site.

Survey Results

You can view aggregate results of your survey and filter this data based on date and field selection by going to the Survey Results. You access Survey Results by clicking on the Results navigation item in the Gravity Forms toolbar. If you have multiple Add-Ons installed that support Results, you will need to rollover the 「Results」 navigation item and then select 「Survey Results」.

Survey Merge Tags

The Survey Add-On includes a few specific merge tags for use in notifications and confirmations.

{score} — displays the score for a specific survey question.{survey_total_score} – displays the total score for the survey.

Validation Errors CSS Selectors

Validation Error MessageValidation – Error ContainerValidation – Error Description Message

Validation Error Message
Main validation error message shown at the top of the form.

example: validation error message (div) – applies to all forms
body .gform_wrapper .validation_error {border: 1px solid red}

example: validation error message (div) – applies just to form ID #1
body #gform_wrapper_1 .validation_error {border: 1px solid red}

Validation – Error Container
Individual list items containing inputs with invalid values

example: validation – error container (li) – applies to all forms
body .gform_wrapper .gform_body .gform_fields .gfield_error {border: 1px solid red}

example: validation – error container (li) – applies just to form ID #1
body #gform_wrapper_1 .gform_body .gform_fields .gfield_error {border: 1px solid red}

Validation – Error Description Message
Description/error message below inputs with invalid values

example: validation – error description message (div) – applies to all forms
body .gform_wrapper .gform_body .gform_fields .gfield_error .validation_message {border: 1px solid red}

example: validation – error description message (div) – applies just to form ID #1
body #gform_wrapper_1 .gform_body .gform_fields .gfield_error .validation_message {border: 1px solid red}

Verifying Your Stripe Integration

Pre-RequisitesVerifying Your Integration

Pre-Requisites

Set Up The Stripe Add-On
Set Up a Stripe Compatible Form
Create a Feed for the Stripe Add-On

Verifying Your Integration
Now that your Stripe Add-On is integrated with Gravity Forms, you can test this integration through the submission of forms via Gravity Forms.

Make sure you have a visible Pricing Field with a valid Price in your form. You can ensure this by selecting Forms, hovering over your form and selecting Edit. Once in Form Editor view, double check your pricing field and make sure the price field has a value. The image below is an example of what your Pricing Field might look like. Ensure you have a Field Label and a Price and click Update Form.

Next select Preview from the form editor toolbar. This will open a new tab. Fill in all of the information prior to the Credit Card field.

The Credit Card field does not require real credit card information. Instead, you will need to visit Stripe to obtain a Test Credit Card Number.

Enter a test credit card number into the Card Number box. Fill in the Expiration Date, Security Code, and Cardholder Name fields. Note that the expiration date needs to be in the future to be valid.

Submit the form.

Once you have submitted the form, visit Stripe and navigate to your Dashboard.

If you selected either Products & Services or Subscription, you will see that your transaction has gone through under Payments.

If you selected Subscription as your transaction type and don』t see funds transferred under Payments, it is most likely because you have setup a Trial period for the Subscription. You can view the date and the amount your customer will be charged by selecting Customers and then selecting the individual customer you would like more information on.

If you can see that your transaction has processed either as a payment or a pending transaction, your Stripe Add-On has been successfully integrated with Gravity Forms! If you need more information on setting up your Stripe Add-On, visit the Stripe Add-On documentation.

Video Tutorials

Three Quick Start VideosLonger Video Tutorials

Three Quick Start Videos
Click this link to see our sequence of three very short videos to quickly get you through the basics of downloading, installing, creating a form, embedding a form, and even installing and connecting a sample add-on. Don』t forget the previous/next button at the bottom of each page to cycle through them all!
After those quick intros, you can dive deeper with the Getting Started documentation category on this very site.
Longer Video Tutorials
Head over to this page on our main site for a selection of longer, topic-specific videos. They cover areas like enabling notifications and confirmations, using conditional logic, creating a survey and even collecting credit card payments with Stripe.