List of Filters and Actions

This is our list of filters and actions available in MailPoet for use by developers. 

A Filter is a function that can be hooked to an event in WordPress (called hooks).

Need a developer to help you? We recommend those at Codeable (affiliate link).

add_action(
	'mailpoet_subscription_before_subscribe',
	function($data, $segmentIds, $form) {
		if ($form->id() !== 10 || !in_array(21, $segmentIds)) {
			return;
		}
		
		
		if ($data['some_custom_field'] === 'wrong') {
			throw new \MailPoet\UnexpectedValueException("You can not use 'wrong' in the some_custom_field.");
		}
	},
	10,
	3
);
		

mailpoet_subscription_limit_window

Overrides throttling window (IP addresses memory span). Default: DAY_IN_SECONDS

mailpoet_subscription_limit_base

Overrides throttling base timeout (the first one that gets doubled every time). Default:  MINUTE_IN_SECONDS

mailpoet_segments_with_subscriber_count

Add dynamic segments on newsletters and subscribers page. 

mailpoet_get_subscribers_in_segment_finders

Enables hooking a finder which can find subscribers in a dynamic segment. 

mailpoet_get_subscribers_listings_in_segment_handlers

Loads listings handlers for subscribers in a dynamic segment. 

mailpoet_subscribers_listings_filters_segments

Loads dynamic segment for subscribers filter.

mailpoet_transient_cache_enabled

A boolean to enable the transient cache for MailPoet. Default is true.

mailpoet_bridge_api_request_timeout

Sets timeout for Bridge API HTTP requests.  Useful on slow hosts where connection times out on large HTTP requests. 

mailpoet_search_terms_args

Update search terms arguments. Useful for sites with a lot of tags to prioritise categories in search. 

mailpoet_manage_subscription_page_form_fields 

Customize form fields displayed on the Manage Subscription page. The argument is an array of fields and their properties.

mailpoet_manage_subscription_page

Customize the template of the Manage Subscription page. The argument is a rendered HTML code of the page to be displayed. 

mailpoet_unsubscribe_confirmation_page 

Change confirmation sentence. The URL to confirm unsubscribing is sent as a 2nd parameter to the filter.

mailpoet_display_custom_fonts 

Disable Google Fonts to stop loading it.

mailpoet_display_form_supported_post_types

Add a custom post type where forms should be displayed.

mailpoet_display_form_in_product_listing

Set whether forms should be displayed on Shop page / product listings (default to `true`)

mailpoet_re_captcha_size

It can be either normal or compact (docs).

MailPoet Premium