gpeu_unsubscribe_url_args

  1. Description
  2. Usage
  3. Parameters
  4. Since

Description

Filter the arguments used to build the unsubscribe URL.

Usage

Applied globally

add_filter( 'gpeu_unsubscribe_url_args', 'my_custom_function' );

Applied to specific form

add_filter( 'gpeu_unsubscribe_url_args_FORMID', 'my_custom_function' );

Parameters

$unsubscribe_info array

Settings used to construct the unsubscribe URL that will be sent in the email.

email string

The email address to unsubscribe.

fid int

The form ID.

scope string

The scope of the unsubscribe action. Defaults to unsubscribing from all emails. To unsubscribe the email from the current form’s emails, change the scope to form_id.

url string|null

The URL to redirect to after unsubscribing. If left null, a generic unsubscribe page will be used.

$entry array

The current entry.

$email string

The email address being unsubscribed.

Since

  • 2.0.13 Hook added.