PayPal Add-on Developer Docs

Introduction

The PayPal Add-on provides an assortment of hooks, filters, and capabilities that can be used to modify the default functionality or extend it.

Hooks and Filters

Following is a list of available hooks and filters.

Form Submission

The following hooks are fired when a Gravity Form with an attached PayPal feed is submitted.

• gform_paypal_query

  Use this filter to modify the query string that will be sent to PayPal

• gform_paypal_request

  Use this filter to modify the URL that will be sent to PayPal. This is the full URL, including the query string

Settings / Feed Configuration

The following hooks are fired within the PayPal Add-on's settings page and the feed configuration page and allow you to add new or modify existing settings and configuration meta.

• gform_paypal_action_fields

  This hook is used add individual options to the PayPal feed.

• gform_paypal_add_option_group

  This hook is used to add groups of options to the PayPal feed.

• gform_paypal_save_config

  This filter allows custom configuration options to be saved to the PayPal feed.

• gform_paypal_config_validation

  This filter allows custom configuration options to be validated.

IPN

• gform_paypal_pre_ipn

  This filter is used to cancel to IPN processing.

• gform_paypal_invoice

  This filter allows the invoice number, sent to PayPal, to be changed.

• gform_paypal_fulfillment

  This hook runs when a PayPal transaction is completed successfully.

• gform_paypal_post_ipn

  This hook fires after the PayPal IPN has returned a response.

• gform_subscription_canceled

  This hook fires when a PayPal subscription is canceled.

• gform_post_payment_status

  This hook fires after any entries payment status has been updated.

Role Management

The User Registration Add-on introduces some new capabilities to the WordPress Role system. For more information, check out the Role Management page.