Polls Add-On Settings Reference

Polls Add-On Settings Reference

IntroductionAccessing the Polls Add-On SettingsPolls Add-On Settings

Introduction

Besides the field level settings available within the Poll field, there are additional form-level settings available within the Polls Add-On, giving you more flexibility to control your poll as it pertains to the display and behavior of your poll on a particular form.

Accessing the Polls Add-On Settings

Log into your WordPress admin dashboard.Click on Forms on the left side navigation menu, and click on your desired form.On the top menu, there is a menu item labeled Settings. Hover over it and click on Polls.

Polls Add-On Settings

ResultsShows results to the user after a vote has been submitted. Enabled by default.Results LinkShows the 「View Results」 link that displays before the vote has been placed. Enabled by default. PercentagesShows the percentages from the poll results. Enabled by default. CountsSimilar to the Percentages option but enables or disables the display of vote counts. Enabled by default.StyleAdjusts the color of the results between the options of Green, Blue, Red, and Orange.Block Repeat VotersChoosing 「Block repeat voters using cookie」 will attempt to store a cookie in the user browser to limit this user from voting again. You are able to set the time frame that this cookie expires, thus allowing later votes from this user, but delayed.

When making changes to the poll settings, they will affect any polls within the particular form you have selected. Other forms will need to have their poll settings edited separately.

Password

Password

SummaryCommon SettingsGeneral SettingsNotes

Summary

The Password field provides two single line inputs (one to enter the password and the second to confirm it) that will mask entered content with blobs or asterisks. It is available under the Advanced Fields section within the form editor. The Password field is only available when the User Registration add-on is active.

Password field as displayed in the Field Library

Password field as displayed in the Form Editor.

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

SettingDescriptionToggle Confirm Password InputThis toggle allows you to control the visibility of the confirm password input.Enable Password Visibility ToggleEnabling this option adds a toggle allowing the user to see the password they are entering in rather than the masked characters.Enable Password StrengthEnabling this option will force the user to enter a password which meets the minimum strength requirement. See note 1.Minimum StrengthSet the minimum strength requirement for the password. Options are None, Short, Bad, Good, and Strong.Custom Sub-LabelsEnter values in this setting to override the default sub label for each field.

Notes

1. This feature utilizes the same library that WordPress core does to determine the level of strength for the password entered into the form by the user.

2. For security purposes, the password field is not stored in any Gravity Forms database tables.

Permitted File Types for Uploading

Permitted File Types for Uploading

SummaryWhat Is Permitted?Changes in WordPress 5.0.1, December 2018Additional InfoThird-Party PluginsMime Type ResourcesWordPress core filters

Summary

This article details the permitted file types allowed for the File Uploads field. Note that this does not consider any additional restrictions placed by the form designer using the 「Allowed file extensions」 option, which will further limit allowed uploads.

What Is Permitted?

The File Upload field is limited in permitted file types by the WordPress core rules for file uploading. You can find more information on the official site and within WordPress codex documents like this one. Note the changes below though regarding WP 5.0.1!

Changes in WordPress 5.0.1, December 2018

Security changes released in WordPress 5.0.1 have changed the way uploaded files are validated, breaking some previously accepted file types. MIME Type validation is now performed, meaning that the content of uploaded files must now match their extension. WordPress states in this blog article that

「Most valid files should be unaffected, but there may be cases when a file needs to be renamed to its correct extension (e.g., an OpenOffice doc going from .pptx to .ppxs).」

With this change for example, the Microsoft Office Word file type .DOCX type will no longer validate properly, and will be rejected from uploading. The .DOC extensions may upload normally.

Note as mentioned in the article security patches are backported to the 3.7 branch, so these BC breaks also apply to versions 4.9.9, 4.8.8, etc.

Additional Info

Below are links for third-party plugins or information which can be used to modify permitted MIME types in file uploading. Use them at you own risk; Gravity Forms cannot guarantee their accuracy or effectiveness, especially noting that some of them were written prior to WordPress 5.0.1.

Third-Party Plugins

Lord of the Files: Enhanced Upload SecurityMime Types PlusWP Add Mime TypesWP Extra File Types

Mime Type Resources

If you』re looking to find the actual MIME type returned by certain applications, the MIME Type Checker includes a reference but also allows you to upload a file to pull out the MIME type.

WordPress core filters

When WordPress validation for the file type fails and the above third-party plugins can』t help, you can also try using the upload_mimes WordPress filter to implement your own solution.

You can find below a few examples:

// Add AI files mime type to WordPress.
add_filter( 'upload_mimes', function( $mime_types ) {
$mime_types['ai'] = 'application/pdf'; // Adding .ai extension

return $mime_types;
}, 1, 1 );

// Add MS Word .doc files mime type to WordPress.
add_filter( 'upload_mimes', function( $mime_types ) {
$mime_types['doc'] = 'application/msword'; // Adding .doc extension

return $mime_types;
}, 1, 1 );

If you need help to add snippets to your site, please check the following link for more details: Where Do I Put This Code?

Option

Option

SummaryCommon SettingsGeneral SettingsField Types OptionsAppearance SettingsMerge TagsUsageModifiers

Summary

The Option field allows the creation of options for products created by a Product. Option fields have special functionality which displays how much selecting the option will add (or subtract) from the total. It is available under the Pricing Fields section within the form editor.

Option field as displayed in the Field Library

Option field as displayed in the Form Editor.

Important: If your choice labels contain any HTML or special characters such as ampersands, commas, hyphens or brackets of any type, you MUST enable the show values feature and give each choice a simple and unique value which does not contain any special characters. Failure to configure values could cause issues for features such as calculations, conditional logic, dynamic population, and validation.

Common Settings

This field uses only common field settings for the 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

SettingDescriptionProduct Field MappingSelect which product this field is tied to. This option is only available when there are two or more products. When only one product exists, Option and Quantity will automatically apply to that product.Field TypeSelect the type of field from the available form fields. See Field Types Options below.

Field Types Options

SettingDescriptionDrop DownThe Drop Down field type will display as a drop down field on your form.CheckboxesThe Checkboxes field type will display as a group of checkbox fields on your form.Radio ButtonsThe Radio Buttons field type will display your product options as radio buttons.

Appearance Settings

SettingDescriptionEnable enhanced user interfaceBy selecting this option, the Chose jQuery library will become active, allowing drop downs to be searched.

Merge Tags

For more information on the use of merge tags, refer to these articles.

Usage

{Field Name:2}

Modifiers

This merge tag does not have any modifiers.

PayPal Payments Pro Change Log

PayPal Payments Pro Change Log

2.7 | 2021-05-052.6 | 2020-09-242.5 | 2020-05-132.4 | 2019-08-072.3 | 2018-01-262.2 | 2017-04-282.1.1 | 2016-12-012.1 | 2016-08-312.0 | 2016-02-241.7 | 2014-12-101.6 | 2014-11-051.5 | 2014-09-051.4 | 2014-09-031.3 | 2014-02-201.2 | 2014-02-171.11.0 | 2013-11-07

2.7 | 2021-05-05

Fixed an issue with the form settings menu icon.

2.6 | 2020-09-24

Added support for Gravity Forms 2.5.
Removed the extra authentication check from the hourly subscription status cron job.

2.5 | 2020-05-13

Added translations for Hebrew, Hindi, Japanese, and Turkish.
Updated API request logging when an error occurs to include the curl error message and debug info.
Fixed an issue with subscriptions where recurring payments aren』t recorded in the entry notes.

2.4 | 2019-08-07

Added security enhancements.
Added GPL to plugin header.
Updated Plugin URI and Author URI to use https.
Updated subscription status cron logging statements.
Removed temporary plugin page.

2.3 | 2018-01-26

Added support for Gravity Forms 2.3.
Fixed a PHP notice which would occur when sending a request to PayPal.

2.2 | 2017-04-28

Added security enhancements.
Added translations.

2.1.1 | 2016-12-01

Fixed strings for translations.

2.1 | 2016-08-31

Updated logging statements.
Updated to abort authorize()/subscribe() before sending request to PayPal if card number not provided.
Fixed an issue with the API override settings.
Fixed an issue with check_status() not passing the $action['type'] for use with the related hooks in the framework.

2.0 | 2016-02-24

Completed Add-On Framework migration.
Added the $submission_data, $feed, and $entry parameters to the gform_paypalpaymentspro_args_before_payment and gform_paypalpaymentspro_args_before_subscription filters.
Added support for sending notifications on payment/subscription events. Configured on the edit notification page using the 'Event' setting.

1.7 | 2014-12-10

Updated to change the frequency of when process_renewal function will run to prevent performance issues.

1.6 | 2014-11-05

Fixed a notice in the logging tab with the logging add-on enabled.
Fixed issue with initial setup up fee amount not being charged for subscription profiles.
Updated POT file.

1.5 | 2014-09-05

Updated the Password entry in the settings page to hide the value of password from the browser when inspecting the element.
Fixed invalid function call.

1.4 | 2014-09-03

Added PayPal partner integration.
Added post product payment hook; gform_paypalpaymentspro_post_capture.
Updated to perform extra check for array response returned by PayPal.
Updated to perform a single Sale transaction for Products and Services. Authorization transaction has been eliminated for Product and Services.
Updated to perform credit card authorization as part of Profile Creation for Subscriptions. Authorization of $0.00 will still show in PayPal Payments Pro for Subscriptions.
Updated logging for clarity.
Updated to remove URL encoding for Name Value Pair info sent to PayPal per API docs.

1.3 | 2014-02-20

Updated the Password entry in the feed's override settings to be a password input so it is not visible as typed.

1.2 | 2014-02-17

Updated the Password entry on the Settings page to be a password input so it is not visible as typed.

1.1

Updated to perform a Sale transaction rather than a DelayedCapture transaction for product and services so that funds are captured immediately after the Authorization transaction.
Updated to not encode email address before it is sent to PayPal.

1.0 | 2013-11-07

Updated to include Vendor and Partner variables to connect to API.
Fixed account authorization issue when password included special charcaters (i.e. !).
Updated to void initial authorization transaction.

Obtaining Your Mailchimp API Key

Obtaining Your Mailchimp API Key

To use the Mailchimp Add-On for Gravity Forms, you will first need to obtain a Mailchimp API key. In this article, we will show you how to get your Mailchimp API key.

Log into your Mailchimp account.
Click on your name (or profile image) at the bottom left of the screen, then click on Account.
Click on Extras, then API keys.
If you have never used Mailchimp』s API before, you will need to generate an API key. To do so, scroll down the page to the section labeled Your API Keys and click on the Create A Key button.
The page will reload and the Your API keys section will now be populated with your new key.

Poll Shortcode

Poll Shortcode

SummaryParameters

Summary

The Polls shortcode uses the standard Gravity Forms shortcode but introduces a new action that tells Gravity Forms to make the form behave as a poll. The Polls shortcode can be used anywhere within WordPress where shortcodes are supported. For most users, this will primarily be within the content of a WordPress post or page.

Here is an example Poll shortcode showing passed parameters.

1[gravityform action="polls" id="1" mode="poll" style="red" cookie="1 month" show_results_link="true" display_results="true" percentages="true" counts="true" ]

Parameters

ParameterDescriptionidThe id of the form to be embedded. (required)modeYou can choose to display the poll or just the results of the poll. Supported modes: poll or results. Defaults to 『poll』. (optional)titleShows or hides the form title. Defaults to true.descriptionShows or hides the form description. Defaults to true.confirmationEnables or disables the confirmation message on the form. Defaults to false.styleThe add-on currently supports four built in styles: red, green, orange, blue. Defaults to 『green』. (optional)cookieSets a time period to restrict repeat voting, using a browser cookie. Options are 1 day, 1 week, 1 month, or a specific date in the YYYY-MM-DD date format. Defaults to an empty string, which means repeat voting is permitted.show_results_linkDisplay a link to view poll results without submitting the form. Supported values are: true, false. Defaults to 『true』. (optional)display_resultsDisplay poll results automatically when the form is submitted. Supported values are: true, false. Defaults to 『true』. (optional)ajaxEnables or disabled AJAX submission of the poll. Defaults to false.percentagesDisplay results percentages as part of results. Supported values are: true and false. Defaults to 『true』. (optional)countsDisplay number of times each choice has been selected when displaying results. Supported values are: true, false. Defaults to 『true』. (optional)tabindexSets a custom tab index on the poll. Accepts numerical values.

Most of the parameters available for the Polls shortcode action are optional. A form can be presented as a poll without including most of these parameters.

{payment_action} Merge Tag

{payment_action} Merge Tag

SummaryUsageModifiers:type:amount:amount_formatted:transaction_type:transaction_id:subscription_id:entry_id:payment_status:note

Summary
The {payment_action} merge tag can be used in notifications assigned to events added by payment add-ons such as Authorize.net, PayPal Standard, PayPal Payments Pro, and Stripe to output details of the event which triggered the notification.
This merge tag was added in Gravity Forms 2.3.6.6.
Usage
{payment_action:[modifier]}
Modifiers
:type
The event action type: complete_payment, refund_payment, fail_payment, add_pending_payment, void_authorization, create_subscription, cancel_subscription, expire_subscription, add_subscription_payment, fail_subscription_payment, or a custom action type added by the add-on.
:amount
The transaction amount without currency formatting.
:amount_formatted
The transaction amount with currency formatting.
:transaction_type
The transaction type: authorization, payment, or refund.
:transaction_id
The ID of the transaction returned by the payment gateway.
:subscription_id
The ID of the subscription returned by the payment gateway.
:entry_id
The entry ID of the submission.
:payment_status
The current payment status of the entry: Authorized, Paid, Processing, Pending, Active, Expired, Failed, Cancelled, Approved, Reversed, Refunded, Voided, or a custom status added by the add-on.
:note
The note which was added to the entry for this event by the add-on.

Personal Data Settings

Personal Data Settings

SummaryFeaturesAccessing Personal Data SettingsGeneral SettingsNoteExporting and Erasing DataOptions Displayed When An Email Address Field Exists on FormFields Added Using the gform_personal_data_identification_fields FilterEmail Address Field Does Not Exist on Form

Summary

Added in Gravity Forms version 2.4, the Personal Data tab of the Form Settings provides integration with the WordPress Export Personal Data and Erase Personal Data tools. Data for both entries and draft submissions (save & continue) are supported.

This new functionality is part of GDPR compliance. See the article WordPress Gravity Forms And GDPR Compliance for more details.

Features

Add-Ons may define custom personal data items that will be added to the exporting and erasing process using the gform_personal_data filter.The storage of IP addresses may be prevented. The IP address section on the entry detail page will be hidden if the IP address is empty.Entries may be deleted or trashed after a specified number of days.Fields containing user IDs may be added to the list of available options to identify users when exporting/erasing customer data by using the gform_personal_data_identification_fields filter. Examples are the created_by field or fields where the default value has been set to use {user:ID}Entries may be rescued at the last minute before automatic deletion according to the retention policy using the gform_entry_ids_automatic_deletion filter. An example for using this would be the User Registration Add-On preventing deletion of entries which are still pending activation.

Accessing Personal Data Settings

While viewing your form, mouse-over the Form』s Settings menu and select the Personal Data option.

After selecting Personal Data, you will be presented with the following screen:

General Settings

SettingDescriptionIP AddressesCheck this toggle if you do not want IP Addresses stored upon form submission.Retain entries indefinitelyEntries will never be deleted.Trash entries automaticallyEntries will be trashed automatically after a specified number of days. See note.Delete entries permanently automaticallyEntries will be deleted permanently automatically after a specified number of days. See note.

Note

The minimum number of days allowed is one. This is to ensure that all entry processing is complete before deleting/trashing. The number of days setting is a minimum, not an exact period of time. The trashing/deleting occurs during the daily cron task so some entries may appear to remain up to a day longer than expected.

Exporting and Erasing Data

Check the Enable box if you would like to include data from this form when exporting or erasing personal data on this site. Once you have checked the Enable box, you will be presented with a drop down to identify what to use to uniquely identify the data, and a list of available data to export/erase.

Options Displayed When An Email Address Field Exists on Form

TagDescriptionIdentification Field Drop DownWhen an email address field exists on the form, the Identification Field drop down will be populated with the Email field as an option to select. The field chosen in this drop down will be used to identify the owner of the personal data.Personal DataA listing of data which may be marked to be exported or erased will also be displayed. This list includes the form fields, along with several key pieces of data normally saved.

Fields Added Using the gform_personal_data_identification_fields Filter

Fields that have been added using the gform_personal_data_identification_fields filter will appear as a selection in the Identification Field drop down. The fields added need to be a way to uniquely identify user data. The created_by field and fields set to use the {user:ID} merge tag may be used.

Email Address Field Does Not Exist on Form

If an email address does not exist on the form, the Enable option is disabled. The email address is needed as a means to identify the data to be exported/erased.

Page Break

Page Break

SummaryCommon SettingsStart Paging MarkerGeneral SettingsPage Break MarkerGeneral SettingsNext Button and Previous Button SettingsEnd Paging MarkerGeneral SettingsPrevious Button SettingsMerge Tags

Summary

The Page field allows the creation of multi-page forms. The Page field is available under the Standard Fields section within the field library sidebar of the form builder.

Adding a Page field will automatically add three new markers to your form:

a Start Paging marker at the top of your form. a Page Break marker in the position you dragged to.an End Paging marker at the bottom of your form.

Each one of these sections offer different settings, all of which are explained here.

Page field as displayed in the Field Library

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.

Start Paging Marker

The Start Paging field will always appear at the top of your form (after a Page Break field is added to your form). This field is used to specify general options that define the behavior of your multi-page form.

General Settings

SettingDescriptionProgress IndicatorSelect which type of visual progress indicator you would like to display. Available options are Progress Bar, Steps or None.StyleSelect which progress bar style you would like to use. Select custom to choose your own text and background color.Page NamesName each of the pages on your form. Page names are displayed with the selected progress indicator.Display completed progress bar on confirmationCheck this box if you would like the progress bar to display with the confirmation text.

Page Break Marker

The Page Break field specifies exactly where one page ends and the next page begins. You can add as many Page Break fields as you need and each carries settings that will customize the behavior for that page only. Setting here affect the page laid out before the page break field.

General Settings

Next Button and Previous Button Settings

SettingDescriptionDefaultIf selected, you can enter a text string into that will show on the relevant page button.ImageIf selected, you can enter the path to an image you would like to use as the page button.

End Paging Marker

The End Paging field occurs at the bottom of your form. It provides an option to modify the Previous button, which appears on the last page.

General Settings

Previous Button Settings

See the same options above in the Page Break marker.

Merge Tags

This field does not support merge tags.