- \n
- Settings API<\/a><\/li>\n\n\n\n
- Creating Plugin Settings<\/a><\/li>\n\n\n\n
- Including Scripts And Styles When Using The Add-On Framework<\/a><\/li>\n\n\n\n
- Including And Using Entry Meta With The Add-On Framework<\/a><\/li>\n\n\n\n
- Object Locking<\/a><\/li>\n\n\n\n
- Creating a Results Page<\/a><\/li>\n\n\n\n
- Uninstalling<\/a><\/li>\n<\/ul>\n\n\n\n
Creating Feed Settings<\/h2>\n\n\n\n
The feed settings UI is generated by overriding the feed_settings_fields() function and returning an array with the configuration for each of the fields. The configuration array follows the same structure as the form settings configuration. See the Settings API<\/a> for further details on the structure of the array.<\/p>\n\n\n\n
Feed Settings Fields Example<\/h3>\n\n\n
\npublic function feed_settings_fields() {\n return array(\n array(\n 'title' => 'Simple Form Settings',\n 'fields' => array(\n array(\n 'label' => 'My checkbox',\n 'type' => 'checkbox',\n 'name' => 'enabled',\n 'tooltip' => 'This is the tooltip',\n 'choices' => array(\n array(\n 'label' => 'Enabled',\n 'name' => 'enabled'\n )\n )\n ),\n array(\n 'label' => 'My checkboxes',\n 'type' => 'checkbox',\n 'name' => 'checkboxgroup',\n 'tooltip' => 'This is the tooltip',\n 'choices' => array(\n array(\n 'label' => 'First Choice',\n 'name' => 'first'\n ),\n array(\n 'label' => 'Second Choice',\n 'name' => 'second'\n ),\n array(\n 'label' => 'Third Choice',\n 'name' => 'third'\n )\n )\n ),\n array(\n 'label' => 'My Radio Buttons',\n 'type' => 'radio',\n 'name' => 'myradiogroup',\n 'tooltip' => 'This is the tooltip',\n 'choices' => array(\n array(\n 'label' => 'First Choice'\n ),\n array(\n 'label' => 'Second Choice'\n ),\n array(\n 'label' => 'Third Choice'\n )\n )\n ),\n array(\n 'label' => 'My Horizontal Radio Buttons',\n 'type' => 'radio',\n 'horizontal' => true,\n 'name' => 'myradiogrouph',\n 'tooltip' => 'This is the tooltip',\n 'choices' => array(\n array(\n 'label' => 'First Choice'\n ),\n array(\n 'label' => 'Second Choice'\n ),\n array(\n 'label' => 'Third Choice'\n )\n )\n ),\n array(\n 'label' => 'My Dropdown',\n 'type' => 'select',\n 'name' => 'mydropdown',\n 'tooltip' => 'This is the tooltip',\n 'choices' => array(\n array(\n 'label' => 'First Choice',\n 'value' => 'first'\n ),\n array(\n 'label' => 'Second Choice',\n 'value' => 'second'\n ),\n array(\n 'label' => 'Third Choice',\n 'value' => 'third'\n )\n )\n ),\n array(\n 'label' => 'My Text Box',\n 'type' => 'text',\n 'name' => 'mytext',\n 'tooltip' => 'This is the tooltip',\n 'class' => 'medium',\n 'feedback_callback' => array( $this, 'is_valid_setting' )\n ),\n array(\n 'label' => 'My Text Area',\n 'type' => 'textarea',\n 'name' => 'mytextarea',\n 'tooltip' => 'This is the tooltip',\n 'class' => 'medium merge-tag-support mt-position-right'\n ),\n array(\n 'label' => 'My Hidden Field',\n 'type' => 'hidden',\n 'name' => 'myhidden'\n ),\n array(\n 'label' => 'My Custom Field',\n 'type' => 'my_custom_field_type',\n 'name' => 'my_custom_field'\n ),\n array(\n 'type' => 'feed_condition',\n 'name' => 'mycondition',\n 'label' => __( 'Opt-In Condition', 'simplefeedaddon' ),\n 'checkbox_label' => __( 'Enable Condition', 'simplefeedaddon' ),\n 'instructions' => __( 'Process this example feed if', 'simplefeedaddon' )\n ),\n )\n ),\n array(\n 'title' => esc_html__( 'This is the title for Section 1', 'sometextdomain' ),\n 'fields' => array(\n array(\n 'name' => 'metaData',\n 'label' => esc_html__( 'Metadata', 'sometextdomain' ),\n 'type' => 'dynamic_field_map',\n 'limit' => 20,\n 'exclude_field_types' => 'creditcard',\n 'tooltip' => '<h6>' . esc_html__( 'Metadata', 'sometextdomain' ) . '<\/h6>' . esc_html__( 'You may send custom meta information to [...]. A maximum of 20 custom keys may be sent. The key name must be 40 characters or less, and the mapped data will be truncated to 500 characters per requirements by [...]. ', 'sometextdomain' ),\n 'validation_callback' => array( $this, 'validate_custom_meta' ),\n ),\n ),\n ),\n );\n}\n<\/pre><\/div>\n\n\nThe code above will render a Form Settings page for the Simple Add-On similar to this:
![\"Form](\"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2014\/05\/GFFeed_Form_Settings_Fields.png\")
<\/a><\/p>\n\n\n\nDynamic Feed Mapping<\/h3>\n\n\n\n
Dynamic feed mapping can be used to create fields which automatically map to values in the form. For example, if you need to create a feed that uses information such as a first name and last name, field mapping would be used to map the form fields to those values.<\/p>\n\n\n\n
A dynamically mapped field can be implemented just like many of the other feed settings fields and setting the setting field type to dynamic_field_map<\/strong>. Adding a feed section containing dynamically mapped fields would look something like the following:<\/p>\n\n\n
\narray(\n 'title' => esc_html__( 'This is the title for Section 1', 'sometextdomain' ),\n 'fields' => array(\n array(\n 'name' => 'metaData',\n 'label' => esc_html__( 'Metadata', 'sometextdomain' ),\n 'type' => 'dynamic_field_map',\n 'limit' => 20,\n 'exclude_field_types' => 'creditcard',\n 'tooltip' => '<h6>' . esc_html__( 'Metadata', 'sometextdomain' ) . '<\/h6>' . esc_html__( 'You may send custom meta information to [...]. A maximum of 20 custom keys may be sent. The key name must be 40 characters or less, and the mapped data will be truncated to 500 characters per requirements by [...]. ', 'sometextdomain' ),\n 'validation_callback' => array( $this, 'validate_custom_meta' ),\n ),\n ),\n)\n<\/pre><\/div>\n\n\n
More information on the dynamic_field_map<\/em> field type can be found on the dynamic_field_map<\/em> Field documentation<\/a>.<\/p>\n\n\n\n
Adding Columns to Feed List<\/h2>\n\n\n\n
To add columns to the list of feeds, override the feed_list_columns() function and return an array of column keys with their corresponding titles. The values will be rendered to the list automatically, but if you need to customize the value just before it is rendered to the list, declare a function with the name get_column_value_[column key] and pass the $feed object as a parameter to the function. The feed object is an associative array with the keys as defined in feed_settings_fields() with the corresponding values for the current row.<\/p>\n\n\n\n
Adding Columns to Feed List Example<\/h3>\n\n\n\n
This example adds two columns to the feed list. The columns are titled “Name” and “My Textbox”. The get_column_value_mytext function returns the value for the “mytext” field as bold text.<\/p>\n\n\n
\nprotected function feed_list_columns() {\n return array(\n 'feedName' => __( 'Name', 'simplefeedaddon' ),\n 'mytext' => __( 'My Textbox', 'simplefeedaddon' )\n );\n}\n\n\/\/ customize the value of mytext before it is rendered to the list\npublic function get_column_value_mytext( $feed ){\n return '<b>' . rgars( $feed, 'meta\/mytext' ) . '<\/b>';\n}\n<\/pre><\/div>\n\n\nThe code above will render a Feed List page similar to the following:
![\"Adding](\"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2014\/05\/GFFeed_Adding_Columns_to_Feed_List.png\")
<\/a><\/p>\n\n\n\nProcessing Feeds<\/h2>\n\n\n\n
Override the process_feed() method to add code to handle feed processing, such as passing the form entry values to a third-party service.<\/p>\n\n\n
\n\/**\n * Processes feed action.\n *\n * @param array $feed The Feed Object currently being processed.\n * @param array $entry The Entry Object currently being processed.\n * @param array $form The Form Object currently being processed.\n *\n * @return void|null|bool|WP_Error|array The returned value determines if the feed status is saved to the \"feed_{$feed_id}_status\" entry meta.\n * - void or null when the feed status should not be saved.\n * - false or a WP_Error when a failed status should be saved.\n * - true or the entry array when a success status should be saved.\n *\/\npublic function process_feed( $feed, $entry, $form ) {}\n<\/pre><\/div>\n\n\nWe recommend using get_field_value() to retrieve the entry value for a mapped field, e.g.<\/p>\n\n\n
\n$email = $this->get_field_value( $form, $entry, $feed['meta']['listFields_email'] );\n<\/pre><\/div>\n\n\n
save_entry_feed_status()<\/h3>\n\n\n
\npublic function save_entry_feed_status( $result, $entry_id, $feed_id, $form_id ) {}\n<\/pre><\/div>\n\n\nsave_entry_feed_status<\/code> was added in Gravity Forms version 2.9.4, It is called by\u00a0GFFeedAddOn::maybe_process_feed()<\/code>\u00a0and\u00a0GF_Feed_Processor::task()<\/code>\u00a0after the feed has been processed, and is passed the value returned by\u00a0process_feed()<\/code>.<\/p>\n\n\n\nParameters<\/h4>\n\n\n\n
- \n
$result<\/code> null|bool<\/a>|array<\/a>|WP_Error|Exception
The value returned byprocess_feed()<\/code>.<\/li>\n\n\n\n$entry_id<\/code> int<\/a>
The ID of the entry the feed was processed for.<\/li>\n\n\n\n$feed_id<\/code> int<\/a>
The ID of the feed that was processed.<\/li>\n\n\n\n$form_id<\/code> int<\/a>
The ID of the form the entry and feed belong to.<\/li>\n<\/ul>\n\n\n\npost_process_feed()<\/h3>\n\n\n
\npublic function post_process_feed( $feed, $entry, $form ) {}\n<\/pre><\/div>\n\n\npost_process_feed<\/code> was added in Gravity Forms version 2.9.4. It is called by\u00a0GFFeedAddOn::maybe_process_feed()<\/code>\u00a0and\u00a0GF_Feed_Processor::task()<\/code>\u00a0after the feed has been processed. It contains the gform_post_process_feed<\/a> hooks.<\/p>\n\n\n\nParameters<\/h4>\n\n\n\n
- \n
$feed<\/code> array<\/a>
The feed that was processed.<\/li>\n\n\n\n$entry<\/code> array<\/a>
The entry the feed was processed for.<\/li>\n\n\n\n$form<\/code> array<\/a>
The form the entry and feed belong to.<\/li>\n<\/ul>\n\n\n\nfulfill_entry()<\/h3>\n\n\n
\npublic function fulfill_entry( $entry_id, $form_id ) {}\n<\/pre><\/div>\n\n\nfulfill_entry<\/code> was added in Gravity Forms version 2.9.4. It is called by\u00a0GFFeedAddOn::maybe_process_feed()<\/code>\u00a0and\u00a0GF_Feed_Processor::task()<\/code>\u00a0after the feed has been processed. It sets the{slug}_is_fulfilled<\/code> entry meta totrue<\/code>.<\/p>\n\n\n\nParameters<\/h4>\n\n\n\n
- \n
$entry_id<\/code> int<\/a>
The entry ID.<\/li>\n\n\n\n$form_id<\/code> int<\/a>
The form ID.<\/li>\n<\/ul>\n\n\n\nImplementing a Feed Condition Setting<\/h2>\n\n\n\n
A feed condition setting is a feed setting that automatically adds an optional conditional logic setting to the feed. The field is configured just like the other fields (see the Settings API<\/a>) with the the following properties:<\/p>\n\n\n\n
- \n
- type<\/strong> string<\/a>
‘feed condition’<\/li>\n\n\n\n- name<\/strong> string<\/a>
The name for the setting.<\/li>\n\n\n\n- label<\/strong> string<\/a>
The label for the feed condition setting.<\/li>\n\n\n\n- checkbox_label<\/strong> string<\/a>
The label that appears to the right of the checkbox used to enable the condition. If this is not set, the default translated string “Enable Condition” is used.<\/li>\n\n\n\n- instructions<\/strong> string<\/a>
The instruction text appears above the conditional logic drop downs, is followed by the All\/Any drop down selection, and the translated text “of the following match”. If you do not specify instruction text, the text “Process this feed if” is used.<\/li>\n<\/ul>\n\n\n\nFeed Condition Field Examples<\/h3>\n\n\n\n
This is a simple example that uses the basic settings to create the feed condition field.<\/p>\n\n\n
\narray(\n 'type' => 'feed_condition',\n 'name' => 'sample_condition',\n 'label' => 'Feed Condition',\n)\n<\/pre><\/div>\n\n\n
The code above will render the feed condition field as follows:
![\"Feed](\"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2014\/05\/Fields_Feed_Condition_Simple_Example.png\")
<\/a><\/p>\n\n\n\nThis example includes setting the checkbox_label and instructions.<\/p>\n\n\n
\narray(\n 'type' => 'feed_condition',\n 'name' => 'mycondition',\n 'label' => __( 'Opt-In Condition', 'simplefeedaddon' ),\n 'checkbox_label' => __( 'Enable Condition', 'simplefeedaddon' ),\n 'instructions' => __( 'Process this example feed if', 'simplefeedaddon' )\n)\n<\/pre><\/div>\n\n\n
The code above will render the feed condition field as follows:
![\"Settings](\"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2014\/05\/Fields_Feed_Condition_Example.png\")
<\/a><\/p>\n\n\n\nAsynchronous Feed Processing<\/h2>\n\n\n\n
As of Gravity Forms version 2.2, feeds can be loaded asynchronously. This means that instead of processing all of the feeds at once, the feeds will be loaded individually.<\/p>\n\n\n\n
GFFeedAddOn $_async_feed_processing Property<\/h3>\n\n\n\n
To load a feed asynchronously, set the $_async_feed_processing<\/a> property within the GFFeedAddOn<\/em> class to true<\/em>.<\/p>\n\n\n\n
Example<\/strong>:<\/p>\n\n\n
\nclass My_Feed_AddOn extends GFFeedAddOn {\n public $_async_feed_processing = true;\n}\n<\/pre><\/div>\n\n\ngform_is_feed_asynchronous Filter<\/h3>\n\n\n\n
Example<\/strong>:<\/p>\n\n\n
\nadd_filter( 'gform_is_feed_asynchronous'. '__return_true' );\n<\/pre><\/div>\n\n\n
See gform_is_feed_asynchronous<\/a><\/p>\n\n\n\n
Further Reading<\/h2>\n\n\n\n
The following articles may also be useful:<\/p>\n\n\n\n
- \n
- Sending Notifications on Custom Events when using the Add-On Framework<\/a><\/li>\n\n\n\n
- Adding a Note to the Entry when using the Add-On Framework<\/a><\/li>\n\n\n\n
- Accessing Mapped Field Values During Feed Processing<\/a><\/li>\n<\/ul>\n\n\n\n
Sample Feed Add-On<\/h2>\n\n\n\n
A sample feed add-on is available which demonstrates the basic functions of GFFeedAddOn:<\/p>\n\n\n\n
- Adding a Note to the Entry when using the Add-On Framework<\/a><\/li>\n\n\n\n
- name<\/strong> string<\/a>
- Creating Plugin Settings<\/a><\/li>\n\n\n\n