bookmark_bordergform_SLUG_error

Description

This action hook can be used to perform a custom action when an Add-on Framework based add-on experiences an error when processing a feed.

Slugs

These slugs are currently supported:

  • gform_agilecrm_error
  • gform_batchbook_error
  • gform_breeze_error
  • gform_campfire_error
  • gform_capsulecrm_error
  • gform_dropbox_error
  • gform_highrise_error
  • gform_icontact_error
  • gform_slack_error
  • gform_trello_error

Usage

The base hook which would run for all feeds and would be used like so:

add_action( 'gform_batchbook_error', 'your_function_name', 10, 3 );

To target feeds for a specific form append the form id to the hook name. (format: gform_SLUG_error_FORMID)

add_action( 'gform_batchbook_error_10', 'your_function_name', 10, 3 );

Parameters

Examples

1. Batchbook API Issue

This example shows how you can trigger the sending of a notification if the Batchbook API could not be initialized.

add_action( 'gform_batchbook_error', 'send_batchbook_error_email', 10, 3 );
function send_batchbook_error_email( $feed, $entry, $form ) {
    GFAPI::send_notifications( $form, $entry, 'batchbook_api_issue' );
}

The batchbook_api_issue notification event would be added via the gform_notification_events filter.

Placement

This code should be placed in the functions.php file of your active theme

Source Code

gf_do_action( "gform_{$slug}_error", array( $form['id'] ), $feed, $entry, $form );

This hook is located in GFFeedAddOn::add_feed_error() in includes/addon/class-gf-feed-addon.php

Since

This hook was added in Gravity Forms 1.9.11.9.