Gravity Forms 文件

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.

Poll Merge Tags

{all_poll_results}{gpoll}

The Polls Add-On introduces two new Gravity Forms Merge Tags that can be used anywhere within Gravity Forms where merge tags are supported. Merge Tags are primarily used in the Form Confirmation message and Notification messages to output the results of a Poll Field or All Poll Fields within the content of the message. The Polls related merge tags also introduce parameters to the Gravity Forms Merge Tags.

{all_poll_results}

Displays the results of all Poll Fields that exist in the form.

Example:

{all_poll_results: style="green" percentages="true" counts="false"}

Following image shows how the above example of the all_poll_results merge tag may look on output.

ParameterDescriptionstyleThe add-on currently supports four built in styles: red, green, orange, blue. Defaults to 『green』. (optional)percentagesDisplay results percentages as part of results. Supported values are: true, 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)

{gpoll}

Displays the results of a specific Poll Field defined in the merge tag.

Example:

{gpoll: field=2 style="red" percentages="true" counts="true"}

Following image shows how the above example of the gpoll merge tag may look on output.

ParameterDescriptionfieldThe id of the field you would like to display. (required)styleThe add-on currently supports four built in styles: red, green, orange, blue. Defaults to 『green』. (optional)percentagesDisplay results percentages as part of results. Supported values are: true, 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)

Pipe

SummaryCommon SettingsSpecialty Field SettingsScreenshotsMerge TagsUsageModifiers

Summary

The Pipe Recorder field is added to your available Gravity Forms field list only if you have installed the official Gravity Forms Pipe Add-On. This document describes the special field settings unique to this field. For information on the more common field setting that are also available for this field, refer to this guide.

Pipe field as displayed in the Field Library

Pipe 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.

Specialty Field Settings

All these settings are found under the General settings tab for the field.

SettingDescriptionVideo ResolutionThe resolution that videos should be recorded in.WidthThe width of the video recorder field.HeightThe height of the video recorder field.Max Recording TimeThe maximum length that a recording can be.Add bottom menuInclude the bottom menu within the recording window.Autosave videosIf videos should automatically be saved upon submission.Record audio onlyOnly record audio and not video while recording.Mirror image while recordingShows the webcam flipped horizontally while recording. Text shown to the webcam can not be read. The final recording will not be flipped regardless of this setting,

Screenshots

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.

Pipe Change Log

1.3 | 2020-09-281.2 | 2020-04-271.1 | 2018-04-051.0 | 2017-08-08

1.3 | 2020-09-28

Added support for Gravity Forms 2.5.

1.2 | 2020-04-27

Added translations for Hebrew, Hindi, Japanese, and Turkish.
Updated Javascript files, stylesheets to use minified versions.
Updated link to Pipe account settings page.

1.1 | 2018-04-05

Add GPL to plugin header.
Add security enhancements.
Add support for audio only embeds.
Fix incorrect URL of recorded videos.
Fix JSON string displaying instead of video URL when using {all_fields}.
Updated Plugin URI and Author URI to use https.

1.0 | 2017-08-08

It's all new!

Phone

SummaryCommon SettingsGeneral SettingsCustom FormatMerge TagsUsageModifiersHTML5 Input Type

Summary

The Phone field allows users to enter a phone number. The field will automatically format the entered data based on the selected phone format in the General settings (see note below). It is available under the Advanced Fields section within the form editor.

Phone field as displayed in the Field Library

Phone 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

SettingDescriptionPhone FormatAvailable options are:• domestic US/CANADA style phone number.• long format international phone number.

Custom Format

To change the format for international use you can use a Single Line Text field with an input mask. You can learn more about input masks in this article.

Merge Tags

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

Usage

{Field Name:2}

Notes:

The first of these merge tag parameters is optional and is simply the field name for easier identification.The second parameter defines the field ID within the form. In the example above, it would be field ID 2.

Modifiers

This field does not have any modifiers.

HTML5 Input Type

In order to utilize the HTML5 tel input type for the phone field, you must have Output HTML5 turned on within the General Settings page. This is found under Forms -> 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.

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?

PayPal Pro – Sending a Custom Product Label and Description

If you need to define a custom product name and description within PayPal using the PayPal Pro add-on, this snippet will allow you to do so:
12345678910111213141516add_filter( 'gform_paypalpro_query_1', 'add_additional_information', 10, 3 );function add_additional_information( $query_string, $form, $entry ) {     // break the query string into an array after removing the initial '&' character    parse_str( ltrim( $query_string, '&' ), $query );     // Set your custom values    $query['L_NAME0'] = 'Your custom product name here';    $query['L_DESC0'] = 'Your custom description here';     // put it all back together again    $query_string = '&' . http_build_query( $query );     // return the query string    return $query_string;}
In this snippet change gform_paypalpro_query_1 to the ID of your form.

PayPal Standard Feed Meta

IntroductionUsagePropertiesProduct or Donation Transaction PropertiesSubscription Transaction PropertiesDelayed Payment Properties

Introduction
The Feed Object meta for the PayPal Standard add-on is an associative array containing the properties which determine what type of transaction should occur and what values are sent to PayPal.
12345678910$feed['meta'] = array(    'feedName'                                => 'Your Feed Name',    'paypalEmail'                             => '[email protected]',    'mode'                                    => 'test',    'transactionType'                         => 'product',    'feed_condition_conditional_logic'        => true,    'feed_condition_conditional_logic_object' => array(        'conditionalLogic' => array(),    ),);
Usage
We recommend accessing the $feed meta using the rgar() or rgars() function, e.g.:
1$conditional_logic_enabled = rgars( $feed, 'meta/feed_condition_conditional_logic' );

Properties

feedName string
The feed name which appears on the add-ons feeds tab.

paypalEmail string
The PayPal email address where payment should be received.

mode string
Determines if the PayPal development sandbox should be used when testing or if live payments should be received. Possible values: production or test.

transactionType string
The type of transaction which should occur when the feed is processed. Possible values: product, subscription or donation.

billingInformation_firstName string
The ID of the field containing the customer』s first name.

billingInformation_lastName string
The ID of the field containing the customer』s last name.

billingInformation_email string
The ID of the field containing the customer』s email.

billingInformation_address string
The ID of the field containing the first line of the customer』s address.

billingInformation_address2 string
The ID of the field containing the second line of the customer』s address.

billingInformation_city string
The ID of the field containing the city of the customer』s address.

billingInformation_state string
The ID of the field containing the state of the customer』s address.

billingInformation_zip string
The ID of the field containing the zip of the customer』s address.

billingInformation_country string
The ID of the field containing the country of the customer』s address.

pageStyle string
Which PayPal page style should be used if you have setup a custom payment page style with PayPal.

continueText string
The text that should appear on the continue button once payment has been completed via PayPal.

cancelUrl string
The URL the user should be sent to should they cancel before completing their PayPal payment.

disableShipping boolean
Do not prompt buyer to include a shipping address. Default false.

disableNote boolean
Do not prompt buyer to include a note with payment. Default false.

delayNotification boolean
Send out selected notifications only after payment has been received. Default false.

selectedNotifications array
An array of notification IDs which should be delayed.

feed_condition_conditional_logic boolean
Is the feed condition (conditional logic) setting enabled. Default is false.

feed_condition_conditional_logic_object array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

Product or Donation Transaction Properties
The following properties are only applicable when the transactionType is set to product or donation.

paymentAmount string
What to use for the payment amount. Possible values: form_total or a product field ID.

Subscription Transaction Properties
The following properties are only applicable when the transactionType is set to subscription.

recurringAmount string
What to use for the recurring amount. Possible values: form_total or a product field ID.

billingCycle_length integer
How often should the recurring payment occur. Maximum values: 90 days, 52 weeks, 24 months or 5 years.

billingCycle_unit string
What unit to use with the billingCycle_length. Possible values: day, week, month or year.

recurringTimes integer
How many times the recurring payment should be made. The default (0) is to bill the customer until the subscription is canceled.

recurringRetry boolean
Try to bill again after failed attempt. Default is false.

trial_enabled boolean
Should the recurring charge occur immediately or after a trial period? Default false.

trial_product string
What is the source of the amount the user should be charged during the trial. Possible values: enter_amount or a product field ID.

trial_amount string
The amount the user should be charged during the trial if enter_amount is selected for the trial_product.

trialPeriod_length integer
How long should the trial last. Maximum values: 90 days, 52 weeks, 24 months or 5 years.

trialPeriod_unit string
What unit to use with the trialPeriod_length. Possible values: day, week, month or year.

Delayed Payment Properties
The following properties are only applicable when the 「action only when payment is received.」 options are being used.

type string
See transactionType. Only for backwards compatibility with non-framework add-ons.

recurring_amount_field string
See recurringAmount. Only for backwards compatibility with non-framework add-ons.

update_user_action string
User Registration add-on integration. What role should the user be assigned when the subscription is cancelled.

update_site_action string
User Registration add-on integration. Update site when the subscription is cancelled. Possible values: deactivate or delete.

delay_registration boolean
User Registration add-on integration. Register user only when payment is received.

delay_gravityformsaweber boolean
Aweber add-on integration. Subscribe user to AWeber only when payment is received.

delay_gravityformscampaignmonitor boolean
Campaign Monitor add-on integration. Subscribe user to Campaign Monitor only when payment is received.

delay_gravityformsmailchimp boolean
MailChimp add-on integration. Subscribe user to MailChimp only when payment is received.

delay_gravityformstwilio boolean
Twilio add-on integration. Send SMS only when a payment is received.

delay_gravityformszapier boolean
Zapier add-on integration. Send feed to Zapier only when payment is received.

PayPal Service Upgrade

PayPal StandardPayPal Payments Pro & PayPal Pro

This alert relates to a change made by Paypal in 2017
PayPal have announced that in an effort to strengthen security they are upgrading their SSL certificates to SHA-256. They are performing a staged rollout across all their web and API endpoints.
As this is a server/SSL certificate issue, the Gravity Forms PayPal Add-Ons do not require any changes; however, we will be releasing updates which will alert you if your server does not support the newer SHA-256 standard.
PayPal isn』t alone in making this change; many organizations are upgrading their SSL certificates to the newer SHA-256 standard. For this reason most hosts should have already begun upgrading their servers to support this new standard. You may want to contact your hosting provider to check if the server hosting your site supports SHA-256.
If your site has an SSL certificate you should also check if it needs upgrading to SHA-256. You can do this by using the SHAChecker tool.
See more from Paypal regarding security here.
PayPal Standard
The endpoint used by the PayPal IPN service is due to be upgraded anytime between September 9-30, 2015. You may have already received an email from PayPal with the subject 『IMMEDIATE ATTENTION REQUIRED』 notifying you about the certificate upgrade for www.paypal.com to SHA-256.
If the server hosting your site does not currently support SHA-256, your customers will still be able to make payments using the add-on; however, the PayPal IPN will not be able to update the entry payment status or transaction details on your site.
Note: When using the PayPal Standard Add-On you don』t need an SSL certificate.
PayPal Payments Pro & PayPal Pro
The SHA-256 upgrade for the endpoint used by the PayPal Payments Pro Add-On is currently planned for October 7, 2015.
The upgrade of the endpoint used by the PayPal Pro Add-On is currently planned for Q2, 2016.
To use either of these add-ons your site should have an SSL certificate.
If your certificate is not using the newer standard or the server hosting your site is not compatible with SHA-256 then once PayPal has made this change you may find that the credit card field will return a validation error when submitting the form.