Hooks

CampaignMonitor

7 hooks fired by CampaignMonitor: 4 filters and 3 actions across 7 call sites.

7 hooks fired by CampaignMonitor: 4 filters and 3 actions across 7 call sites. 7 of the 7 call sites are described by a docblock, at the call or on the constant that names the hook; the rest are listed with their signature and call sites only. Paths are relative to the plugin directory.

$named

Action · Dynamic name · 3 arguments · 1 call site

Fires for one kind of Campaign Monitor event.

The hook names are xpac_campaign_monitor_subscribed, xpac_campaign_monitor_deactivated — an unsubscribe, a bounce or a spam complaint — and xpac_campaign_monitor_updated.

do_action( $named, $email, $list, $event )
  • $email (string) — The address the event is about.
  • $list (string) — The Campaign Monitor list ID.
  • $event (array) — The event as Campaign Monitor sent it.

Fired from:

  • packages/CampaignMonitor/Addon.php:922

xpac-forms-after-settings-modal-content

Filter · 3 arguments · 1 call site

Content appended inside a settings panel's item modal.

applyFilters( 'xpac-forms-after-settings-modal-content', [], { value: options, onChange: onUpdate, }, HANDLE )

Fired from:

  • assets/packages/campaign-monitor/Components/Modal.js:475

xpac_campaign_monitor_check_options

Filter · 2 arguments · 1 call site

Filters whether a select answer is checked against the field's options.

Off sends what the visitor typed and lets Campaign Monitor discard it, which is what every release before this one did.

apply_filters( 'xpac_campaign_monitor_check_options', true, $item['list'] )
  • $check (bool) — Whether to check. Default true.
  • $list (string) — The list the action writes to.

Fired from:

  • packages/CampaignMonitor/Addon.php:2300

xpac_campaign_monitor_optin_lookup_limit

Filter · 1 argument · 1 call site

Filters how many lists the editor reads the opt-in setting for.

One request each, so an agency client with hundreds of lists would turn opening the panel into hundreds of round trips.

apply_filters( 'xpac_campaign_monitor_optin_lookup_limit', 25 )
  • $limit (int) — Lists to look up. Default 25.

Fired from:

  • packages/CampaignMonitor/Addon.php:1130

xpac_campaign_monitor_request_timeout

Filter · 1 argument · 1 call site

Filters how long, in seconds, to wait for Campaign Monitor to reply.

The request no longer runs inside the visitor's submission, so this is a tolerance for a slow API rather than a latency budget: nothing is waiting on it, and a timeout shorter than Campaign Monitor's own response time turns a subscriber that was added into a needless retry.

apply_filters( 'xpac_campaign_monitor_request_timeout', 10 )
  • $timeout (int) — Seconds to wait. Default 10.

Fired from:

  • packages/CampaignMonitor/Client.php:77

xpac_campaign_monitor_values_dropped

Action · 2 arguments · 1 call site

Fires when Campaign Monitor took the subscriber but not every answer.

do_action( 'xpac_campaign_monitor_values_dropped', $dropped, $submission )
  • $dropped (array) — One entry per answer, naming the form field, the Campaign Monitor key, the value and why it was refused.
  • $submission (Submission) — The form instance.

Fired from:

  • packages/CampaignMonitor/Addon.php:2378

xpac_campaign_monitor_webhook_event

Action · 4 arguments · 1 call site

Fires for every event Campaign Monitor posts back about a list.

do_action( 'xpac_campaign_monitor_webhook_event', $type, $email, $list, $event )
  • $type (string) — Subscribe, Deactivate or Update.
  • $email (string) — The address the event is about.
  • $list (string) — The Campaign Monitor list ID.
  • $event (array) — The event as Campaign Monitor sent it.

Fired from:

  • packages/CampaignMonitor/Addon.php:903

On this page