Gravity Forms 文档

Accessing Mapped Field Values During Feed Processing

Introductionget_mapped_field_value()ParametersReturnsUsesUsage Exampleget_field_value()ParametersReturnsUsesHooksUsage Examplemaybe_override_field_value()ParametersReturnsHooksUsage Exampleget_full_address()ParametersReturnsget_full_name()ParametersReturnsget_list_field_value()ParametersReturnsget_{$input_type}_field_value()

Introduction
The following functions are located in the GFAddon class; they are also available for use by add-ons which extend the GFFeedAddOn or GFPaymentAddOn classes and can be used to retrieve the mapped form field values during feed processing in the process_feed() method.
get_mapped_field_value()
1protected function get_mapped_field_value( $setting_name, $form, $entry, $settings = false ) {}
Source: Inline Documentation

Parameters

$setting_name string
The setting name; the key to the setting value in the Feed Object meta array.

$form Form Object
The form currently being processed.

$entry Entry Object
The entry currently being processed.

$settings array
The Feed Object meta.

Returns
(string) The value of the mapped field.
Uses

includes/addon/class-gf-addon.php: get_field_value()

Usage Example
1$value = $this->get_mapped_field_value( $meta_key, $form, $entry, $feed['meta'] );
get_field_value()
1public function get_field_value( $form, $entry, $field_id ) {}
Source: Inline Documentation

Parameters

$form Form Object
The Form currently being processed.

$entry Entry Object
The Entry currently being processed.

$field_id string
The ID of the Field currently being processed.

Returns
(string) The value of the specified field.
Uses

includes/addon/class-gf-addon.php: get_full_address()
includes/addon/class-gf-addon.php: get_full_name()
includes/addon/class-gf-addon.php: get_list_field_value()
includes/addon/class-gf-addon.php: maybe_override_field_value()
get_{$input_type}_field_value()

Hooks
This function contains the following hooks:

gform_addon_field_value

Usage Example
1$email = $this->get_field_value( $form, $entry, rgar( $feed['meta'], 'customerInformation_email' ) );
maybe_override_field_value()
1public function maybe_override_field_value( $field_value, $form, $entry, $field_id ) {}
Override this function to prevent the gform_short_slug_field_value filter being used if you need to implement a custom filter, or need to perform custom formatting of some field types.
Source: Inline Documentation

Parameters

$field_value string
The value to be overridden.

$form Form Object
The Form currently being processed.

$entry Entry Object
The Entry currently being processed.

$field_id string
The ID of the Field currently being processed.

Returns
(string) The field value.
Hooks
This function contains the following hooks:

gform_short_slug_field_value

Usage Example
12$coupon_field_id = rgar( $feed['meta'], 'customerInformation_coupon' );$coupon = $this->maybe_override_field_value( rgar( $entry, $coupon_field_id ), $form, $entry, $coupon_field_id );
get_full_address()
1protected function get_full_address( $entry, $field_id ) {}
Override this function if your add-on needs to reformat the Address field value.
Source: Inline Documentation

Parameters

$entry Entry Object
The Entry currently being processed.

$field_id string
The ID of the Field currently being processed.

Returns
(string) Returns the combined value of the specified Address field.
get_full_name()
1protected function get_full_name( $entry, $field_id ) {}
Override this function if your add-on needs to reformat the Name field value.
Source: Inline Documentation

Parameters

$entry Entry Object
The Entry currently being processed.

$field_id string
The ID of the Field currently being processed.

Returns
(string) Returns the combined value of the specified Name field.
get_list_field_value()
1protected function get_list_field_value( $entry, $field_id, $field ) {}
Override this function if your add-on needs to reformat the List field value.
Source: Inline Documentation

Parameters

$entry Entry Object
The Entry currently being processed.

$field_id string
The ID of the Field currently being processed.

$field Field Object
The Field currently being processed.

Returns
(string) Returns the formatted value of the specified List field or List field column.
get_{$input_type}_field_value()
To perform custom formatting of values for a specific field or input type you can define a custom function to be used when the get_field_value() processes that field type. Just replace {$input_type} in the function name with the field type you want to format e.g.
12345678public function get_phone_field_value( $entry, $field_id, $field ) { $field_value = rgar( $entry, $field_id ); if ( ! empty( $field_value ) && $field->phoneFormat == 'standard' && preg_match( '/^D?(d{3})D?D?(d{3})D?(d{4})$/', $field_value, $matches ) ) { $field_value = sprintf( '%s-%s-%s', $matches[1], $matches[2], $matches[3] ); } return $field_value;}

How To Manually Update For Older WordPress Editions

To manually update Gravity Forms on WordPress versions 5.4 or older, follow the step below.

For more recent WordPress versions, refer to our master article here.

If you haven』t already done so, download the Gravity Forms or Add-On zip from the downloads page. Be sure to save this zip file somewhere easily accessible as you will need it soon.From within your WordPress admin dashboard, click Plugins on the left side navigation menu.If the plugin is active, select the Deactivate option for the plugin you』re trying to update.Select the Delete option for the plugin you』re trying to update.Click OK or Yes when prompted to delete the files. This step deletes the plugin』s folder and the files inside. The data part of the message in the prompt does NOT apply to Gravity Forms or our official add-ons. As mentioned above your data will remain.Click the Add New button.Click the Upload Plugin button.Click the Browse button.Navigate to the zip file you previously downloaded and select it.Once the file is selected, click the Install Now button.Click the Activate Plugin button.

Managing Notes with the GFAPI

Introductionget_notesParametersReturnsUsage ExamplesGetting all notes for the specified entryget_noteParametersReturnsUsage Exampleadd_noteParametersReturnsUsage ExamplesAdding a user notedelete_noteParametersReturnsUsage Exampleupdate_noteParametersReturnsUsage ExamplesUpdating the note content

Introduction
The GFAPI methods for managing notes were added in Gravity Forms 2.4.18.
See the GFAPI article for other available methods.

get_notes
Returns the notes for the given search criteria.
public static function get_notes( $search_criteria = array(), $sorting = null ) {}
Parameters

$search_criteria array
Optional. An array containing one or more of the following arguments.

id int
The ID of the note to be retrieved.
entry_id int
The ID of the entry the notes are to be retrieved for.
user_id int
The ID of the user the notes are to be retrieved for.
user_name string
The user_name of the user the notes are to be retrieved for.
note_type string
The type of note to be retrieved.
sub_type string
The sub type of note to be retrieved.
start_date string
Retrieves notes created on or after the date and time specified in the Y-m-d H:i:s format.
end_date string
Retrieves notes created before the date and time specified in the Y-m-d H:i:s format.

$sorting array
Optional. An array containing the sorting arguments.

key string
The column to sort by. See the gf_entry_notes database table columns.
direction string
The direction to sort by: ASC or DESC.

The default sorting arguments are defined like so:
$sorting = array( 'key' => 'id', 'direction' => 'ASC' );

Returns

$result bool|array
False or an array of note objects containing the gf_entry_notes database table columns as properties.

Usage Examples
Getting all notes for the specified entry
$search_criteria = array( 'entry_id' = $entry_id );
$result = GFAPI::get_notes( $search_criteria );

get_note
Returns the specified note.
public static function get_note( $note_id ) {}
Parameters

$note_id int
The ID of the note to be retrieved.

Returns

$result WP_Error|object
A WP_Error if the note was not found or the note object containing the gf_entry_notes database table columns as properties.

Usage Example
$result = GFAPI::get_note( $note_id );

add_note
Adds a note to the specified entry.
public static function add_note( $entry_id, $user_id, $user_name, $note, $note_type = 'user', $sub_type = null ) {}
Parameters

$entry_id int
The ID of the entry the note is being added to.

$user_id int
The ID of the user adding the note.

$user_name string
The user_name of the user adding the note.

$note string
The content of the note being added.

$note_type string
Optional. The type of note being added.

$sub_type string
Optional. The sub type of note being added.

Returns

$result WP_Error|int
A WP_Error if an error occurs or the ID of the note returned by the database.

Usage Examples
Adding a user note
$result = GFAPI::add_note( $entry_id, $user_id, $user_name, 'this is a test note' );

delete_note
Deletes the specified note.
public static function delete_note( $note_id ) {}
Parameters

$note_id int
The ID of the note to be retrieved.

Returns

$result WP_Error|bool
A WP_Error if an error occurs or true on success.

Usage Example
$result = GFAPI::delete_note( $note_id );

update_note
Updates the specified note.
public static function update_note( $note, $note_id = '' ) {}
Parameters

$note array
An array containing one or more of the following arguments.

id int
The ID of the note to be updated.
entry_id int
The ID of the entry the note is for.
user_id int
The ID of the user the note was added by.
user_name string
The user_name of the user the note was added by.
date_created string
The date the note was created in the Y-m-d H:i:s format.
value string
The note content.
note_type string
The note type.
sub_type string
The note sub type.

$note_id string|int
Optional. The ID of the note to be updated when not included in the $note array.

Returns

$result WP_Error|bool
A WP_Error if an error occurs or true on success.

Usage Examples
Updating the note content
$note = array( 'value' = 'the updated note' );
$result = GFAPI::update_note( $note, $note_id );

Managing Forms with WP-CLI

Creating FormsExamplesParametersDeleting FormsExamplesParametersDuplicating FormsExamplesParametersEditing FormsExamplesParametersExporting FormsExamplesParametersListing FormsExamplesParametersGetting FormsExamplesParametersImporting FormsExamplesParametersUpdating FormsExamplesParameters

In this article, we will show you how to do things such as import, export, update, delete, and even create forms using the CLI Add-On for Gravity Forms.
Creating Forms
wp gf form create
Examples

Creates a new form with just a title and description.
wp gf form create 'My Form Title' 'Description Here'

Parameters

Argument
Description

The title of the new form. Overrides the title defined in the optional JSON. [<description>] The description of the new form. Overrides the description defined in the optional JSON. [--form-json=<value>] The JSON formatted form. [--porcelain] If used, outputs just the created form ID instead of the standard success message. Deleting Forms wp gf form delete Examples Move form 5 to the trash. wp gf form delete 5 Permanently delete form 5. wp gf form delete 5 --force Parameters Argument Description <form-id>... One or more IDs of forms to be deleted. [--force] Skips the trash and permanently deletes the form. Duplicating Forms wp gf form duplicate Examples Creates a duplicate copy of form 5. wp gf form duplicate 5 Parameters Argument Description <form-id> The ID of the form to be duplicated. [--porcelain] If used, outputs just the duplicate form ID instead of the standard success message. Editing Forms wp gf form edit Examples Launch the editor for form 5. wp gf form edit 5 Parameters Argument Description <form-id> The ID of the form to be edited. Exporting Forms wp gf form export Examples Exports all forms to the current working directory. wp gf form export Exports form 5 to a specific location. wp gf form export 5 --dir=/my/custom/path Exports form 5 using a custom filename. wp gf form export 5 --filename=testing.json Parameters Argument Description [<form-id>] The ID of the form to export. If not set, exports all forms. [--dir='value'] The path to the location that the export should be stored.Default: current working directory. [--filename='value'] The filename for the form to export. Defaults to the current date. [--porcelain] Overrides the standard success message with just the export file path. Listing Forms wp gf form list Examples Get a JSON formatted list of active forms sorted by id. wp gf form list --active --sort_column=id --format=json Parameters Argument Description [--active] List active forms.Default: true. [--trash] List forms in trash.Default: false. [--sort-column=<value>] The column to sort the list by.Accepted values: id, title, date_created, is_active, and is_trash.Default: id. [--sort-dir=<value>] The direction to use when sorting.Accepted values: ASC or DESC.Default: ASC. [--format=<value>] Defines the format in which the forms will be listed.Accepted values: table, csv, json, and count.Default: table. Getting Forms wp gf form get Examples Gets the JSON for form 5. wp gf form get 5 Parameters Argument Description <form-id> The ID of the form to get. Importing Forms wp gf form import Examples Imports one or more forms from the supplied .json file. wp gf form import /path/to/my/file.json Parameters Argument Description <json-path> The path to a file containing the JSON formatted form(s) to be imported. Updating Forms wp gf form update Examples Updates form 5 using the supplied JSON string. wp gf form update 5 --form-json='{snip}' Updates form 5 using the supplied .json file. wp gf form update 5 --file='/path/to/my/file.json' Parameters Argument Description <form-id> The ID of the form to update. [--form-json=<value>] The JSON formatted form. [--file=<value>] The path to a file containing the JSON formatted form. </div> <footer class="entry-footer"> 发布于 <a href="https://gravityforms.wpwenku.com/document/managing-forms-wp-cli" rel="bookmark"><time class="entry-date published" datetime="2021-12-28T04:33:51+08:00">2021 年 12 月 28 日</time><time class="updated" datetime="2021-12-28T13:04:40+08:00">2021 年 12 月 28 日</time></a><a href="https://gravityforms.wpwenku.com/document/managing-forms-wp-cli#respond">Leave a comment</a> </footer> </article> <article id="post-1217" class="post-1217 post type-post status-publish format-standard hentry category-document"> <header class="entry-header"> <h2 class="entry-title"><a href="https://gravityforms.wpwenku.com/document/managing-form-notifications-with-wp-cli" rel="bookmark">Managing Form Notifications with WP-CLI</a></h2> </header> <div class="entry-content"> Managing Form Notifications with WP-CLIListing Form NotificationsExamplesParametersCreating Form NotificationsExamplesParametersGetting Form NotificationsExamplesParametersDeleting Form NotificationsExamplesParametersDuplicating Form NotificationsExamplesParametersUpdating Form NotificationsExamplesParametersEditing Form NotificationsExamplesParameters By using the CLI Add-On for Gravity Forms, you can easily manage form notifications using the command line. Listing Form Notifications wp gf form notification list Examples Outputs a table listing the notifications for form 1. wp gf form notification list 1 Outputs a table listing the active notifications for form 1. wp gf form notification list 1 --active Outputs the raw properties for the form 1 notifications. wp gf form notification list 1 --raw Parameters Argument Description <form-id> The ID of the form to retrieve the notifications from. [--active] Retrieves only active notifications. [--format=<value>] Defines the format in which the notifications will be listed.Accepted values: table, ids, csv, json, yaml, and count.Defaults to table. [--raw] Outputs the raw notification properties as a JSON string. Creating Form Notifications wp gf form notification create Examples Creates a new notification for form 1 with the specified name. wp gf form notification create 1 'My Notification' Creates a new notification for form 1 with the specified name and to address. wp gf form notification create 1 'My Notification' --to='admin@mysite.com' Parameters Argument Description <form-id> The ID of the form to create the notification for. [<name>] The name to be assigned to the new notification. [--to=<value>] The to field value.Default: {admin_email}. [--subject=<value>] The subject field value.Default: New submission from {form_title}. [--message=<value>] The message field value.Default: {all_fields}. [--to-type=<value>] The send to type field value.Default: email. [--event=<value>] The event field value; when the notification will be sent.Default: form_submission. [--notification-json=<value>] The JSON formatted notification. [--porcelain] Outputs just the notification ID instead of the standard success message. Getting Form Notifications wp gf form notification get Examples Gets the JSON for the specified notification from form 1. wp gf form notification get 1 596e4794a13a2 Parameters Argument Description <form-id> The ID of the form to get the notification from. <notification-id> The ID of the notification to get. Deleting Form Notifications wp gf form notification delete Examples Deletes the specified form 1 notification. wp gf form notification delete 1 596e4794a13a2 Deletes the specified form 1 notifications. wp gf form notification delete 1 596e4794a13a2 574ff8257d864 Parameters Argument Description <form-id> The ID of the form to delete the notification from. <notification-id>... The IDs of the notification to delete. Duplicating Form Notifications wp gf form notification duplicate Examples Duplicates the specified form 1 notification. wp gf form notification duplicate 1 596e4794a13a2 Parameters Argument Description <form-id> The ID of the form to duplicate the notification for. <notification-id> The ID of the notification to duplicate. [--porcelain] Outputs just the new notification ID instead of the standard success message. Updating Form Notifications wp gf form notification update Examples Updates the specified form 1 notification from the supplied JSON. wp gf form notification update 1 --notification-json='{snip}' Updates the specified notification using the supplied JSON. wp gf form notification update 1 abc1 --notification-json='{snip}' Parameters Argument Description <form-id> The ID of the form to update the notification for. [<notification-id>] The ID of the notification to be updated. [--notification-json=<value>] The JSON formatted notification. Editing Form Notifications wp gf form notification edit Examples Launch the editor for the specified form notification. wp gf form notification edit 1 596e4794a13a2 Parameters Argument Description <form-id> The ID of the form the notification to be edited belongs to. <notification-id> The ID of the notification to edit. </div> <footer class="entry-footer"> 发布于 <a href="https://gravityforms.wpwenku.com/document/managing-form-notifications-with-wp-cli" rel="bookmark"><time class="entry-date published" datetime="2021-12-28T04:33:51+08:00">2021 年 12 月 28 日</time><time class="updated" datetime="2021-12-28T13:04:39+08:00">2021 年 12 月 28 日</time></a><a href="https://gravityforms.wpwenku.com/document/managing-form-notifications-with-wp-cli#respond">Leave a comment</a> </footer> </article> <article id="post-1216" class="post-1216 post type-post status-publish format-standard hentry category-document"> <header class="entry-header"> <h2 class="entry-title"><a href="https://gravityforms.wpwenku.com/document/managing-fields-wp-cli" rel="bookmark">Managing Fields with WP-CLI</a></h2> </header> <div class="entry-content"> Managing Fields with WP-CLICreating FieldsExamplesParametersDeleting FieldsExamplesParametersDuplicating FieldsExamplesParametersEditing FieldsExamplesParametersGetting FieldsExamplesParametersListing FieldsExamplesParametersUpdating FieldsExamplesParameters When using the CLI Add-On for Gravity Forms, you are able to easily manage your forms fields using only the command line, via WP-CLI. In this article, we will show you how to do things such as update, delete, and even create form fields using WP-CLI. Creating Fields wp gf field create Examples Create a new text type field for form 1. wp gf field create 1 text 'My Text Field' Create a new select field for form 1 from the supplied JSON. wp gf field create 2 --field-json='{"type": "select", "label": "My Dropdown", "enableChoiceValue": true, "choices": [{"text": "Choice 1", "value":"one"}, {"text": "Choice 2", "value":"two"}]}' Parameters Argument Description <form-id> The ID of the form to create a field in. <type> The type of field to create.Examples: text, textarea, email.See the type properties of the field classes which extend GF_Field. [<label>] The label to associate with the created field. [--field-json=<value>] The JSON formatted field properties. [--porcelain] Outputs just the created field ID. Deleting Fields wp gf field delete Examples Deletes field 2 from form 5. wp gf field delete 5 2 Parameters Argument Description <form-id> The ID of the form that a field will be deleted from. <field-id> The ID of the field to be deleted. Duplicating Fields wp gf field duplicate Examples Duplicates field 2 of form 5. wp gf field duplicate 5 2 Parameters Argument Description <form-id> The ID of the form that a field will be duplicated in. <field-id> The ID of the field to be duplicated. Editing Fields wp gf field edit Examples Launch the editor for field 2 of form 5. wp gf field edit 5 2 Parameters Argument Description <form-id> The ID of the form that contains the field you want to edit. <field-id> The ID of the field to be edited. Getting Fields wp gf field get Examples Gets the JSON for field 2 of form 5. wp gf field get 5 2 Parameters Argument Description <form-id> The ID of the form that contains the field you want to view. <field-id> The ID of the field you want to view. Listing Fields wp gf field list Examples Get a table formatted list of fields from form 5. wp gf field list 5 Parameters Argument Description <form-id> The ID of the form that you want to list fields from. [--format=<value>] Defines the format in which the fields will be listed.Accepted values: table, csv, json, yaml, and count.Default: table. Updating Fields wp gf field update Examples Updates field 2 of form 5 with the supplied JSON. wp gf field update 5 2 --field-json='{"type": "text", "label": "My New Label", "defaultValue": "Just testing"}' Update the specified properties of form 2 field 5. wp gf field update 5 2 --type=text --label='My New Label' Parameters Argument Description <form-id> The ID of the form that contains the field that will be updated. <field-id> The ID of the field you want to update. [--<property>=<value>] The field property and value to be updated. [--field-json=<value>] The JSON formatted field properties. </div> <footer class="entry-footer"> 发布于 <a href="https://gravityforms.wpwenku.com/document/managing-fields-wp-cli" rel="bookmark"><time class="entry-date published" datetime="2021-12-28T04:33:51+08:00">2021 年 12 月 28 日</time><time class="updated" datetime="2021-12-28T13:04:39+08:00">2021 年 12 月 28 日</time></a><a href="https://gravityforms.wpwenku.com/document/managing-fields-wp-cli#respond">Leave a comment</a> </footer> </article> <article id="post-1215" class="post-1215 post type-post status-publish format-standard hentry category-document"> <header class="entry-header"> <h2 class="entry-title"><a href="https://gravityforms.wpwenku.com/document/managing-entry-notifications-with-wp-cli" rel="bookmark">Managing Entry Notifications with WP-CLI</a></h2> </header> <div class="entry-content"> Managing Entry Notifications with WP-CLIGetting Entry NotificationsExamplesParametersSending Entry NotificationsExamplesParameters By using the CLI Add-On for Gravity Forms, you can easily manage entry notifications using the command line. Getting Entry Notifications wp gf entry notification get Examples Gets a table containing the form submission notifications for entry 1. wp gf entry notification get 1 Gets a table containing the payment completed notifications for entry 1. wp gf entry notification get 1 --event=complete_payment Gets a list of payment completed notifications IDs for entry 1. wp gf entry notification get 1 --event=complete_payment --format=ids Parameters Argument Description <entry-id> The ID of the entry the notifications are for. [<notification-id>...] Specific notification IDs to get. If set, this will override the event arg. [--event=<value>] The notification event to retrieve.Default: form_submission. [--format=<value>] Defines the format in which the notifications will be listed.Accepted values: table, ids, csv, json, yaml, and count.Default: table. [--raw] Outputs the raw notification properties as a JSON string. Sending Entry Notifications wp gf entry notification send Examples Sends the form submission notifications for entry 597. wp gf entry notification send 597 Sends the payment completed notifications for entry 597. wp gf entry notification send 597 --event=complete_payment Sends the notifications for entry 597 which match the specified IDs. wp gf entry notification send 597 574ff8257d864 596e53f8104ed Parameters Argument Description <entry-id> The ID of the entry the notifications are to be sent for. [<notification-id>...] The IDs of one or more specific notifications to be sent. If set, this will override the event arg. [--event=<value>] The event to send the notifications for.Default: form_submission. </div> <footer class="entry-footer"> 发布于 <a href="https://gravityforms.wpwenku.com/document/managing-entry-notifications-with-wp-cli" rel="bookmark"><time class="entry-date published" datetime="2021-12-28T04:33:50+08:00">2021 年 12 月 28 日</time><time class="updated" datetime="2021-12-28T13:04:43+08:00">2021 年 12 月 28 日</time></a><a href="https://gravityforms.wpwenku.com/document/managing-entry-notifications-with-wp-cli#respond">Leave a comment</a> </footer> </article> <article id="post-1214" class="post-1214 post type-post status-publish format-standard hentry category-document"> <header class="entry-header"> <h2 class="entry-title"><a href="https://gravityforms.wpwenku.com/document/managing-add-on-feeds-with-the-gfapi" rel="bookmark">Managing Add-On Feeds with the GFAPI</a></h2> </header> <div class="entry-content"> Managing Add-On Feeds with the GFAPIIntroductionget_feedsParametersReturnsUsage Examplesget_feedParametersReturnsUsage Examplesadd_feedParametersReturnsUsage Examplesdelete_feedParametersReturnsUsage Examplesupdate_feedParametersReturnsUsage Examplesfeed_existsParametersReturnsUsage Examplesupdate_feed_propertyParametersReturnsUsage Examples Introduction The following GFAPI methods are used to manage form Feeds. Each Feed contains the properties which determine if and how the form submission is processed by an add-on. See the GFAPI article for other available methods. get_feeds GFAPI::get_feeds() was added in Gravity Forms version 1.8, it is used to get all feeds which match the given search criteria. public static function get_feeds( $feed_ids = null, $form_id = null, $addon_slug = null, $is_active = true ) {} Parameters $feed_ids null|integer|array Optional. The ID of the Feed or an array of Feed IDs. $form_id null|string Optional. The ID of the Form to which the Feeds belong. $addon_slug null|string Optional. The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. $is_active boolean Optional. Default true. Indicates if only active or inactive feeds should be returned. Since 2.4.23.4 null can be used to return both. Returns $result array|WP_Error An array of Feed Objects or a WP_Error instance. Usage Examples Getting all active feeds. $result = GFAPI::get_feeds(); Getting a specific feed. $result = GFAPI::get_feeds( 1 ); Getting multiple specific feeds. $result = GFAPI::get_feeds( array( 1, 5 ) ); Getting all active feeds for a specific form. $result = GFAPI::get_feeds( null, 2 ); Getting all active feeds for a specific add-on. $result = GFAPI::get_feeds( null, null, 'gravityformszapier' ); get_feed GFAPI::get_feed() was added in Gravity Forms version 2.4.23.4, it is used to get a specific feed. public static function get_feed( $feed_id ) {} Parameters $feed_id integer The ID of the feed to retrieve. Returns $result array|WP_Error The Feed Object or a WP_Error instance. Usage Examples $result = GFAPI::get_feed( 1 ); add_feed GFAPI::add_feed() was added in Gravity Forms version 1.8, it is used to add a new feed to the specified form with the given configuration. public static function add_feed( $form_id, $feed_meta, $addon_slug ) {} Parameters $form_id integer The ID of the form to which the feed belongs. $feed_meta array The feed properties, see the meta property of the Feed Object. $addon_slug string The slug of the add-on to which the Feed belongs, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. Returns $result WP_Error|integer A WP_Error if an error occurs or the ID of the Feed returned by the database. Usage Examples $result = GFAPI::add_feed( $form_id, $feed_meta, $addon_slug ); delete_feed GFAPI::delete_feed() was added in Gravity Forms version 1.8, it is used to delete a specific Feed. public static function delete_feed( $feed_id ) {} Parameters $feed_id integer The ID of the Feed Object to be deleted. Returns $result boolean|WP_Error True for success or a WP_Error instance. Usage Examples $result = GFAPI::delete_feed( $feed_id ); update_feed GFAPI::update_feed() was added in Gravity Forms version 1.8, it is used to update the meta for a specific Feed. public static function update_feed( $feed_id, $feed_meta, $form_id = null ) {} Parameters $feed_id integer The ID of the Feed Object to be updated. $feed_meta array The feed properties, see the meta property of the Feed Object. $form_id integer The ID of the form to which the feed belongs. Returns $result boolean|WP_Error True for success or a WP_Error instance. Usage Examples $result = GFAPI::update_feed( $feed_id, $feed_meta, $form_id ); feed_exists GFAPI::feed_exists() was added in Gravity Forms version 2.4.24, it is used to check if a Feed exists for the given ID. public static function feed_exists( $feed_id ) {} Parameters $feed_id integer The ID to be checked. Returns $result boolean Whether or not a Feed Object exists for the supplied ID. Usage Examples $result = GFAPI::feed_exists( $feed_id ); update_feed_property GFAPI::update_feed_property() was added in Gravity Forms version 2.4.24, it is used to update the properties of a specific Feed. public static function update_feed_property( $feed_id, $property_name, $property_value ) {} Parameters $feed_id integer The ID of the Feed Object to be updated. $property_name string The name of the property (column) being updated. Supported: form_id, is_active, feed_order, meta, and addon_slug $property_value string|integer|array The new value of the specified property. The meta property can be passed as an associative array or JSON. Returns $result boolean|WP_Error True for success or a WP_Error instance. Usage Examples $result = GFAPI::update_feed_property( $feed_id, $property_name, $property_value ); $result = GFAPI::update_feed_property( 1, 'is_active', 0 ); </div> <footer class="entry-footer"> 发布于 <a href="https://gravityforms.wpwenku.com/document/managing-add-on-feeds-with-the-gfapi" rel="bookmark"><time class="entry-date published" datetime="2021-12-28T04:33:50+08:00">2021 年 12 月 28 日</time><time class="updated" datetime="2021-12-28T13:04:50+08:00">2021 年 12 月 28 日</time></a><a href="https://gravityforms.wpwenku.com/document/managing-add-on-feeds-with-the-gfapi#respond">Leave a comment</a> </footer> </article> <article id="post-1213" class="post-1213 post type-post status-publish format-standard hentry category-document"> <header class="entry-header"> <h2 class="entry-title"><a href="https://gravityforms.wpwenku.com/document/managing-add-on-feeds-with-rest-api-v2" rel="bookmark">Managing Add-On Feeds with REST API v2</a></h2> </header> <div class="entry-content"> Managing Add-On Feeds with REST API v2Getting FeedsMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample 1Example 2Example 3Getting a Specific FeedMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample 1Getting Feeds for a Specific FormMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample 1Example 2Example 3Adding a FeedMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample RequestExample ResponseAdding a Feed for a Specific FormMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample RequestExample ResponseUpdating a FeedMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample RequestExample ResponsePartially Updating a FeedMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample RequestExample ResponseUpdating Specific Feed PropertiesMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample RequestExample ResponseDeleting a Specific FeedMethodPathRequired PropertiesOptional PropertiesResponseUsage ExamplesExample 1 Getting Feeds Method GET Path /gf/v2/feeds Required Properties There are no required properties. Optional Properties include – The ID of the Feed or an array of Feed IDs. addon – The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. Response The JSON response will contain an array of Feed Objects. [ { "id": "1", "form_id": "0", "addon_slug": "gravityformscoupons", "meta": { "gravityForm": "0", "couponName": "Military Discount", "couponCode": "MD10", "couponAmountType": "percentage", "couponAmount": 10, "startDate": "", "endDate": "", "usageLimit": "", "isStackable": "0", "usageCount": 5 } }, { "id": "6", "form_id": "8", "addon_slug": "gravityformswebhooks", "meta": { "feedName": "My Test", "requestURL": "www.rocketgenius.com", "requestMethod": "POST", "requestFormat": "form", "requestHeaders": [ { "key": "gf_custom", "value": "id", "custom_key": "MyCustomKey", "custom_value": "" } ], "requestBodyType": "all_fields", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } }, { "id": "34", "form_id": "190", "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Creation 10", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } } ] Usage Examples Example 1 This example shows how you can get all active feeds for all forms. https://example.com/wp-json/gf/v2/feeds Example 2 This example shows how you can get specific feeds. https://example.com/wp-json/gf/v2/feeds?include[0]=1&include[1]=32 Example 3 This example shows how you can get all feeds for a specific add-on. https://example.com/wp-json/gf/v2/feeds?addon=gravityformsmailchimp Getting a Specific Feed Method GET Path /gf/v2/feeds/[FEED_ID] Required Properties There are no required properties. Optional Properties There are no optional properties. Response The JSON response will contain a Feed Object. { "id": "1", "form_id": "0", "addon_slug": "gravityformscoupons", "meta": { "gravityForm": "0", "couponName": "Military Discount", "couponCode": "MD10", "couponAmountType": "percentage", "couponAmount": 10, "startDate": "", "endDate": "", "usageLimit": "", "isStackable": "0", "usageCount": 5 } } Usage Examples Example 1 This example shows how you can get a specific feed, in this case feed ID 1. https://example.com/wp-json/gf/v2/feeds/1 Getting Feeds for a Specific Form Method GET Path /gf/v2/forms/[FORM_ID]/feeds Required Properties There are no required properties. Optional Properties include – The ID of the Feed or an array of Feed IDs. addon – The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. Response The JSON response will contain an array of Feed Objects for the specified form. [ { "id": "30", "form_id": "190", "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "MailChimp Feed 2", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } }, { "id": "31", "form_id": "190", "addon_slug": "gravityformsuserregistration", "meta": { "feedName": "User Registration Feed 4", "feedType": "create", "username": "1", "first_name": "1.3", "last_name": "1.6", "nickname": "", "displayname": "nickname", "email": "2", "password": "generatepass", "role": "editor", "userMeta": "", "sendEmail": "1", "userActivationEnable": "0", "userActivationValue": "email", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } } ] Usage Examples Example 1 This example shows how you can get all active feeds for a specific form, in this case form ID 190. https://example.com/wp-json/gf/v2/forms/190/feeds Example 2 This example shows how you can get specific active feeds for a specific form, in this case form ID 190. https://example.com/wp-json/gf/v2/forms/190/feeds?include[0]=31&include[1]=32 Example 3 This example shows how you can get all active Mailchimp feeds for a specific form, in this case form ID 190. https://example.com/wp-json/gf/v2/forms/190/feeds?addon=gravityformsmailchimp Adding a Feed Method POST Path /gf/v2/feeds Required Properties Sent as JSON in the request body. form_id – The ID of the Form the Feed is for. meta – The feed properties, see the meta property of the Feed Object. addon_slug – The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. Optional Properties There are no optional properties. Response The JSON response will contain a Feed Object. Usage Examples Example Request https://example.com/wp-json/gf/v2/feeds { "form_id": "180", "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Creation", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } } Example Response { "form_id": 180, "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Creation x", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] }, "id": 39 } Adding a Feed for a Specific Form Method POST Path /gf/v2/forms/[FORM_ID]/feeds Required Properties Sent as JSON in the request body. meta – The feed properties, see the meta property of the Feed Object. addon_slug – The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. Optional Properties There are no optional properties. Response The JSON response will contain a Feed Object. Usage Examples Example Request https://example.com/wp-json/gf/v2/forms/180/feeds { "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Creation", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } } Example Response { "form_id": 180, "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Creation", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] }, "id": 39 } Updating a Feed Note: prior to version 2.4.23.4 only the feed meta was updated, now the entire feed is updated. Method PUT Path /gf/v2/feeds/[FEED_ID] Required Properties Sent as JSON in the request body. form_id – The ID of the Form the Feed is for. meta – The feed properties, see the meta property of the Feed Object. addon_slug – The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. Optional Properties Sent as JSON in the request body. is_active – Boolean indicating if the feed is active or inactive. feed_order – Integer indicating the order the feed will be displayed in the feeds list for the form. Also applies to submission time feed processing. Not all add-ons support feed ordering. Response The JSON response will contain a Feed Object. Usage Examples Example Request https://example.com/wp-json/gf/v2/feeds/39 { "form_id": "180", "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Update", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } } Example Response { "form_id": "180", "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Update", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] }, "id": "39" } Partially Updating a Feed Support for patching feeds was added in version 2.4.23.4. Method PATCH Path /gf/v2/feeds/[FEED_ID] Required Properties There are no required properties. Optional Properties One or more properties to be updated sent as JSON in the request body. form_id – The ID of the Form the Feed is for. meta – The feed properties, see the meta property of the Feed Object. Only meta properties included in the request will be updated. Any properties not included in the request will remain configured. addon_slug – The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. is_active – Boolean indicating if the feed is active or inactive. feed_order – Integer indicating the order the feed will be displayed in the feeds list for the form. Also applies to submission time feed processing. Not all add-ons support feed ordering. Response The JSON response will contain a Feed Object. Usage Examples Example Request This example shows how to update a feed meta property without having to pass the entire feed. https://example.com/wp-json/gf/v2/feeds/39 { "meta": { "mappedFields_MMERGE4": "3" } } Example Response { "form_id": "180", "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Update", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "3", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] }, "id": "39" } Updating Specific Feed Properties Support for updating specific feed properties feeds was added in version 2.4.23.2. Method PUT Path /gf/v2/feeds/[FEED_ID]/properties Required Properties There are no required properties. Optional Properties One or more properties to be updated sent as JSON in the request body. form_id – The ID of the Form the Feed is for. meta – The feed properties, see the meta property of the Feed Object. You must pass all the meta properties, any not included will be deleted. addon_slug – The slug of the add-on to which the Feeds belong, including the gravityforms prefix. See the Gravity Forms Add-On Slugs article for a list of possible slugs. is_active – Boolean indicating if the feed is active or inactive. feed_order – Integer indicating the order the feed will be displayed in the feeds list for the form. Also applies to submission time feed processing. Not all add-ons support feed ordering. Response The response will contain a message indicating if the operation was successful Usage Examples Example Request This example shows how to update a feed meta property without having to pass the entire feed. https://example.com/wp-json/gf/v2/feeds/39/properties { "is_active": false } Example Response Feed updated successfully Deleting a Specific Feed Method DELETE Path /gf/v2/feeds/[FEED_ID] Required Properties There are no required properties. Optional Properties There are no optional properties. Response The JSON response will indicate if the feed was deleted and will also contain the deleted Feed Object. { "deleted": true, "previous": { "id": "39", "form_id": "180", "addon_slug": "gravityformsmailchimp", "meta": { "feedName": "Test API Feed Creation", "mailchimpList": "b19814053f", "mappedFields_EMAIL": "2", "mappedFields_FNAME": "1.3", "mappedFields_LNAME": "1.6", "mappedFields_MMERGE4": "3", "mappedFields_MMERGE5": "", "mappedFields_MMERGE6": "", "double_optin": "1", "markAsVIP": "0", "note": "", "feed_condition_conditional_logic": "0", "feed_condition_conditional_logic_object": [] } } } Usage Examples Example 1 This example shows how you can delete a specific feed, in this case feed ID 1. https://example.com/wp-json/gf/v2/feeds/1 </div> <footer class="entry-footer"> 发布于 <a href="https://gravityforms.wpwenku.com/document/managing-add-on-feeds-with-rest-api-v2" rel="bookmark"><time class="entry-date published" datetime="2021-12-28T04:33:50+08:00">2021 年 12 月 28 日</time><time class="updated" datetime="2021-12-28T13:04:43+08:00">2021 年 12 月 28 日</time></a><a href="https://gravityforms.wpwenku.com/document/managing-add-on-feeds-with-rest-api-v2#respond">Leave a comment</a> </footer> </article> <article id="post-1212" class="post-1212 post type-post status-publish format-standard hentry category-document"> <header class="entry-header"> <h2 class="entry-title"><a href="https://gravityforms.wpwenku.com/document/manage-gravity-forms-license-key-with-wpcli" rel="bookmark">Managing the Gravity Forms License Key with WP-CLI</a></h2> </header> <div class="entry-content"> Managing the Gravity Forms License Key with WP-CLIUpdating the License KeyExamplesParametersDeleting the License KeyExamples Using the Gravity Forms CLI Add-On and the following commands you can update and delete the Gravity Forms license key from the command line. Updating the License Key wp gf license update Updates the Gravity Forms license key. Examples 123# Updating the plugin to use the specified license key.$ wp gf license update abc123License key updated Parameters Argument Description [<license-key>] A valid Gravity Forms license key. Deleting the License Key wp gf license delete Deletes the Gravity Forms license key. Examples 123# Deleting license key from the plugin.$ wp gf license deleteLicense key deleted </div> <footer class="entry-footer"> 发布于 <a href="https://gravityforms.wpwenku.com/document/manage-gravity-forms-license-key-with-wpcli" rel="bookmark"><time class="entry-date published" datetime="2021-12-28T04:33:50+08:00">2021 年 12 月 28 日</time><time class="updated" datetime="2021-12-28T13:04:42+08:00">2021 年 12 月 28 日</time></a><a href="https://gravityforms.wpwenku.com/document/manage-gravity-forms-license-key-with-wpcli#respond">Leave a comment</a> </footer> </article> <nav class="navigation pagination" aria-label="文章"> <h2 class="screen-reader-text">文章导航</h2> <div class="nav-links"><a class="prev page-numbers" href="https://gravityforms.wpwenku.com/page/32">上一页</a> <a class="page-numbers" href="https://gravityforms.wpwenku.com/">页 1</a> … <a class="page-numbers" href="https://gravityforms.wpwenku.com/page/32">页 32</a> 页 33 <a class="page-numbers" href="https://gravityforms.wpwenku.com/page/34">页 34</a> … <a class="page-numbers" href="https://gravityforms.wpwenku.com/page/154">页 154</a> <a class="next page-numbers" href="https://gravityforms.wpwenku.com/page/34">下一页</a></div> </nav> </main> </div> </div> <footer id="colophon" class="site-footer" role="contentinfo"> <div class="site-info"> Copyright © 2024 <a href="https://gravityforms.wpwenku.com">Gravity Forms 文档</a>, All Rights Reserved. 自豪地采用文派。 </div> </footer> </div>  </body> </html>