Gravity Forms 文檔

Button Object

IntroductionUsageProperties

Introduction
Controls the way the form button is displayed. Contains the form button settings such as the button text.
Usage
$form['button']['type']; // returns the button type
$form['button']['text']; // returns the button text

Properties

type string
Specifies the type of button to be displayed. Possible values: text, image

text: Displays a standard submit button (i.e. )
image: Displays an image button (i.e. )

text string
Contains the button text. Only applicable when type is set to text.

imageUrl string
Contains the URL for the image button. Only applicable when type is set to image.

conditionalLogic Conditional Logic
Controls when the form button should be visible based on values selected on the form.

Bulk Print

Bulk Print Options

The Bulk Print functionality allows you to print multiple entries at once.

Bulk Print Options

OptionDescriptionInclude notesIncludes any notes that have been entered for this entry.Add page break between entriesForces entries to be printed on separate pages.

Bulk Add / Predefined Choices

Custom ChoicesChoices with Label and ValuePredefined Choices

When using a field with Choices (Drop Down, Multi Select, Checkboxes, or Radio Buttons) clicking the Bulk Add / Predefined Choices in General Settings allows you to select a category and customize the predefined choices or paste your own list to bulk add choices. Choices must be separated by a single line break.

Custom Choices

With GF v1.6, it is now possible to create a set of choices and save them as a Custom Choices option.

Note: Custom Choices are saved per form and are not available across the entire site.

Enter your custom choices in the writable textarea in the Bulk Add modal window.When your custom choices are complete, click the 「Save as new custom choice」 text below the writable textarea.An input will slide down. Use this input to specify a name for your custom choice and click the 「Save」 button.

You can update your custom choice by selecting your custom choice from the 「Custom Choices」 list above the 「Predefined Choices」 list. Make any modifications to the options and then click the 「Update」 button. To delete your custom choice, follow the same steps but instead of clicking 「Update」, click 「Delete」.

Choices with Label and Value

When creating custom choices, you can save options with labels and values by using the pipe character ( | ) to separate them.

Label|ValueIf the 「show values」 setting is enabled on the field and the choices will have values that are different from the label, define each choice label and value pair using the pipe character as the separator, e.g. First|1.Label|Value|:$PriceIf it is a pricing field and you want to define the choice label, value, and price, use the pipe to separate the label and value and then a pipe and colon to separate the value and price, e.g. First|1|:$20.00.

Predefined Choices

CountriesU.S. StatesCanadian Province/TerritoryContinentsGenderAgeMarital StatusEmploymentJob TypeIndustryIncomeEducationDays of the WeekMonths of the YearHow OftenHow LongSatisfactionImportanceAgreementComparisonWould YouSize

Breeze Feed Meta

IntroductionUsageProperties

Introduction
The Feed Object meta for the Breeze add-on is an associative array containing the properties which determine how the add-on should process the form submission.
$feed['meta'] = array(
'feedName' => 'Breeze Feed 1',
'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() functions, e.g.:
$conditional_logic_enabled = rgars( $feed, 'meta/feed_condition_conditional_logic' );

Properties

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

project string
The Breeze ID of the project the card will be added to.

list string
The Breeze ID of the list the card will be added to.

cardName string
The name to be assigned to the card. Merge tags are supported.

cardDescription string
The description to be assigned to the card. Merge tags are supported.

cardDueDate string
The ID of the date field or a custom value. Possible values: The ID of a Date type field or gf_custom.

cardDueDate_custom integer
The number of days after today, used when the value of cardDueDate is gf_custom.

cardInvitees array
array(
'USER_EMAIL_HERE' => true,
);

An associative array with the user email as the key to a boolean indicating if the user should be assigned to the card.

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.

Breeze Change Log

1.5 | 2020-09-241.4 | 2020-03-301.3 | 2018-04-091.2 | 2017-05-161.1 | 2016-05-161.0 | 2016-05-12

1.5 | 2020-09-24

Added support for Gravity Forms 2.5.

1.4 | 2020-03-30

Added translations for Hebrew, Hindi, Japanese, and Turkish.
Added support for feed duplication.
Fixed PHP 7.4 notices which occur on the feed configuration page when creating a new feed.
Fixed a PHP fatal error which occurs when accessing an existing feed after the add-on is connected to a different Breeze account.

1.3 | 2018-04-09

Added security enhancements.
Added GPL to plugin header.
Updated Plugin URI and Author URI to use https.
Fixed a PHP warning regarding http_build_query.

1.2 | 2017-05-16

Updated plugin description to be consistent with other Gravity Forms add-ons.
Fixed strings for translations.
Fixed an issue where a due date of Jan 1, 1970 was set on the card.

1.1 | 2016-05-16

Fixed a fatal error when using Gravity Forms 1.9.x.

1.0 | 2016-05-12

It's all new!

Batchbook Change Log

1.3 | 2018-04-091.2 | 2017-01-051.1 | 2016-07-291.0 | 2015-07-28

NOTICE: The Batchbook service was ended, and the official Gravity Forms Batchbook Add-On was also retired . All user guides were removed in 2021.
1.3 | 2018-04-09

Added security enhancements.
Added GPL to plugin header.
Added gform_batchbook_person filter to modify person being created or updated.
Updated Plugin URI and Author URI to use https.
Renamed API class to prevent naming conflicts with other API libraries.

1.2 | 2017-01-05

Fixed strings for translations.
Fixed fatal error related to processing the person company data.
Fixed PHP warning.

1.1 | 2016-07-29

Added feed duplication support.
Added support for delaying feed processing until payment by PayPal Standard is successfully completed.
Updated available field types for mapping to the person first name, last name, and email.

1.0 | 2015-07-28

It's all new!

CSS Element Naming Structure

Element IDsConfigurable ClassesForm Wrapper ClassesTheme & Markup ClassesLabel Position ClassesField Size ClassesCustom ClassesMore Information

Gravity Forms are structured so that every element can be targeted and manipulated via CSS. Most elements share reusable class names to affect styling, and many elements have unique ID』s that you can use to target specific elements within the form. By using CSS inheritance, you can effectively style every element in your form.
Element IDs
Element ID』s utilize the unique ID of the form or field.
For example:

#gform_wrapper_xx where 「xx」 is the form ID, or
#field_xx_yyy where 「xx」 is the form ID and 「yyy」 is the field ID.

Configurable Classes
Form Wrapper Classes
Theme & Markup Classes
There are 2 classes applied to the form wrapper based on whether or not legacy mode is enabled for a form. The class .gravity-theme is applied to all forms that do no have legacy mode enabled. The class .gform_legacy_markup_wrapper is applied to all forms that have legacy mode enabled.
Label Position Classes
There are 3 label classes that are applied to the form wrapper based on the individual form settings, .top_label, .left_label and .right_label.
Other elements change positions, widths, etc. based on inheritance from these label classes.
Field Size Classes
For many of the individual fields, there are classes of .small, .medium and .large which are defined in the form admin by changing the field size setting.
Custom Classes
Finally, for most of the fields, the user can define additional class names with the Custom CSS Class setting in order to apply additional custom styles or to target elements for other types of manipulation.
More Information
We』ve put together a help guide and a visual CSS diagram to illustrate the structure of a form and the CSS class relationships in an article here.
Additionally, review our article of CSS targeting examples for an expanded list of elements.

AWeber Feed Meta

IntroductionUsageProperties

Introduction
The Feed Object meta for the AWeber add-on is an associative array containing the properties which determine how the add-on should process the form submission.
$feed['meta'] = array(
'feedName' => 'Your Feed Name',
'listFields_email' => '2',
'listFields_fullname' => '1',
'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() functions, e.g.:
$conditional_logic_enabled = rgars( $feed, 'meta/feed_condition_conditional_logic' );

Properties

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

account string
The AWeber account ID the contacts will be added to.

contactList string
The AWeber list ID the contacts will be added to.

listFields_email string
The ID of the field containing the user』s email.

listFields_fullname string
The ID of the field containing the user』s full name.

listFields_cf_{custom_field_id} string
The ID of the field containing the value for the custom field.
There would be properties for any custom fields configured for your list, they all begin listFields_cf_ and then end with the custom field ID, e.g. listFields_cf_1.

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.

AWeber Change Log

2.11 | 2020-09-212.10 | 2020-03-112.9 | 2019-08-072.8 | 2018-11-022.7 | 2018-04-022.6 | 2017-10-262.5 | 2017-04-282.4.2 | 2016-11-302.4.1 | 2016-09-022.4 | 2016-07-292.3 | 2015-08-072.2 | 2015-04-202.1 | 2014-11-212.0 | 2014-11-191.4 | 2013-03-051.3 | 2012-06-271.2 | 2012-03-121.1 | 2012-01-18

2.11 | 2020-09-21

Added support for Gravity Forms 2.5.
Fixed an issue where the contact is not created if there are blank tags.

2.10 | 2020-03-11

Added translations for Hebrew, Hindi, Japanese, and Turkish.
Fixed PHP 7.4 notices which occur when saving the settings for the first time.

2.9 | 2019-08-07

Added security enhancements.

2.8 | 2018-11-02

Added the filter gform_aweber_app_id enabling the app id used to authorize the add-on with AWeber to be overridden.
Added support for tags.

2.7 | 2018-04-02

Added security enhancements.
Added License GPL to plugin header.
Updated Plugin URI and Author URI to https.

2.6 | 2017-10-26

Updated API library to support PHP 7.

2.5 | 2017-04-28

Added security enhancements.
Added translations.

2.4.2 | 2016-11-30

Fixed strings for translations.

2.4.1 | 2016-09-02

Added the hook gform_aweber_post_subscriber_created

2.4 | 2016-07-29

Updated to support feed duplication with Gravity Forms 1.9.15+.
Updated the choices for the Email Address field to only list email and hidden type form fields.
Fixed an issue with custom fields returned by the AWeber API which don't have labels.
Fixed fatal error which could occur during feed processing if the configured account ID for the feed becomes invalid.
Fixed fatal error which could occur if the configured account ID for the feed becomes invalid.

2.3 | 2015-08-07

Added form and field specific versions of the gform_aweber_field_value filter.
Updated minimum Gravity Forms version to 1.9.3.
Updated feed processing to use GFAddOn::get_field_value(), if available, when retrieving mapped field values.
Updated 'Opt-In Condition' setting label to 'Conditional Logic'.
Fixed an issue with the feed list page if the AWeber auth code was not valid.
Fixed an issue with the upgrade routine which caused it run even if a pre-framework version hadn't been installed.

2.2 | 2015-04-20

Added hook to allow args to be changed before sending submission to AWeber.
add_filter('gform_aweber_args_pre_subscribe', 'add_ip', 10, 4);
function add_ip( $args, $form, $entry, $feed ){
$args['ip_address'] = $entry['ip'];
return $args;
}
Added support for the middle name input when preparing Name field values.
Updated how Address field values are prepared to also support Gravity Forms 1.9 method for getting country code.
Updated logging statements.
Fixed a low severity security vulnerability in the admin area which could be exploited by authenticated users with form administration permissions.
Fixed issues when upgrading causing feeds not to get created.

2.1 | 2014-11-21

Fixed error when creating new feeds.

2.0 | 2014-11-19

Added integration with Add-On Framework.
Added text domain/path to header.
Added the gform_aweber_field_value filter so the field value can be modified before sending to AWeber.
Updated required version of Gravity Forms to 1.8.17.
Updated POT file.
Updated to not process entries marked as spam.
Fixed an issue where non-string field values would cause the AWeber create subscriber process to fail.

1.4 | 2013-03-05

Added PayPal integration to subscribe user to AWeber only when payment is received.
Updated the AJAX Url to resolve conflicts with sites running over HTTPS.
Fixed issue where spaces after closing php tag caused problems with WP 3.5 release.

1.3 | 2012-06-27

Added logging support.
Added new conditional logic options (greater than, less than, contains starts with, ends with) and support for other conditional fields
Fixed notices.
Fixed issue with API throwing errors on some PHP installations.

1.2 | 2012-03-12

Fixed issue with Full Name field not being sent to AWeber when mapped to custom fields.

1.1 | 2012-01-18

Updated PHP API and using it to subscribe users instead of relying on email
Added support for field mapping
Added hook to allow custom Ad Tracking text to be assigned to the subscriber
add_filter("gform_aweber_ad_tracking", "aweber_ad_tracking", 10, 4); //site wide ad tracking
OR
add_filter("gform_aweber_ad_tracking_20", "aweber_ad_tracking", 10, 4); //form specific ad tracking
function aweber_ad_tracking($ad_tracking, $entry, $form, $feed){
return "Custom Ad Tracking";
}

IMPORTANT: $_collectionMap property in api/aweber.php line 82 has been made public to resolve errors on some PHP installations. When updating API, make sure to re-apply change.

Setting Up the AWeber Add-On

UsesPre-RequisitesRetrieve AWeber Authorization CodeSetup Your AWeber FeedsReady To Go!

Uses
The Gravity Forms AWeber Add-On gives you an easy way to integrate all of your online forms with the AWeber opt-in email marketing service. Collect and add subscribers to your email marketing lists automatically when a form is submitted.

Automatically add subscribers to your email lists when a form is submitted.
Control opt-in and only add subscribers when a certain condition is met.
Automatically sends a double opt-in message to insure only legitimate subscribers are added. (Because the AWeber Add-On uses the API for integration, all submissions will be double opt-in. This is an AWeber restriction.)

Pre-Requisites

Download and install the add-on
An AWeber account

Retrieve AWeber Authorization Code
You will need to retrieve your AWeber Authorization Code to allow Gravity Forms to send data to AWeber. Refer to this article for how to retrieve and enter your authorization code.
Setup Your AWeber Feeds
Now you need to add a feed. Adding an AWeber feed will connect your submitted form data to your AWeber account. For step by step instructions, refer to this article.
Ready To Go!
Now that you have setup an AWeber feed, when the form you selected is submitted, it will automatically send the data you have selected to the AWeber list you have mapped it to. Run a few tests to see it in action!