« Back to Frequently Asked Questions

What filters does the plugin have?

Developers can customise the behaviour of the plugin through filter hooks. There are many useful filter hooks supported by this plugin, and Gravity Forms has many filter hooks too.

Here’s some example code that uses these filter hooks:

  • gfeway_code_description

    • string $message
    • string $code
    • return: string

    Change the eWAY Rapid API error messages.

  • gfeway_customer_ip

    • string $ip
    • return string

    Allow hookers to override the Customer IP address sent to eWAY Beagle rules, for network-specific fixes.

  • gfeway_customer_ref

    • string $customer_ref
    • array $form
    • array $entry (only available for Responsive Shared Page)
    • return: string

    Change the customer reference (mostly useful for Recurring Payments).

  • gfeway_form_is_eway

    • bool $is_eway_form — defaults to true
    • int $form_id
    • return: bool

    Free add-on: Return false to tell Gravity Forms eWAY to ignore a form.

  • gfeway_invoice_amount

    • float $amount
    • array $form
    • array $entry (only available for Responsive Shared Page)
    • return: string

    Change the invoice amount.

  • gfeway_invoice_cust_comments

    • string $comments
    • array $form
    • array $entry (only available for Responsive Shared Page)
    • return: string

    Set customer comments field (Recurring Payments).

  • gfeway_invoice_desc

    • string $description
    • array $form
    • array $entry (only available for Responsive Shared Page)
    • return: string

    Change the invoice description.

  • gfeway_invoice_ref

    • string $invoice_ref
    • array $form
    • array $entry (only available for Responsive Shared Page)
    • return: string

    Change the invoice reference.

  • gfeway_invoice_trans_number

    • string $transaction_number
    • array $form
    • array $entry (only available for Responsive Shared Page)
    • return: string

    Change the invoice transaction reference. NB: must remain unique for each eWAY account!

  • gfeway_recurring_date_end

    • DateTime $endDate
    • DateTime $startDate
    • DateTime $initDate
    • array $inputs
    • array $form
    • array $feed

    Change the date for the last instalment charge for recurring payments.

  • gfeway_recurring_date_init

    • DateTime $initDate
    • array $inputs
    • array $form
    • array $feed

    Change the date for billing an initial charge (e.g. setup fee) for recurring payments.

  • gfeway_recurring_date_start

    • DateTime $startDate
    • DateTime $initDate
    • array $inputs
    • array $form
    • array $feed

    Change the date for the first instalment charge for recurring payments.

  • gfeway_recurring_periods

    • array $periods — default list is ‘weekly’, ‘fortnightly’, ‘monthly’, ‘quarterly’, ‘yearly’
    • int $form_id
    • GF_Field $field
    • return: array

    Free add-on: filter the available recurring periods (from ‘weekly’, ‘fortnightly’, ‘monthly’, ‘quarterly’, ‘yearly’).

  • gfeway_save_card_number_value

    • string $card_numer
    • array $entry
    • array $form
    • return: string

    Allow further modification of obfuscated card numbers returned from Rapid API with Client Side Encryption.