CartRevival 2.33.0 has 22 actions and 117 filters, read directly from its source code on Nov 19, 2026. The list updates automatically when a new version is released.
How to use these hooks
Actions let you run your own code at a specific moment. Filters let you change a value before the plugin uses it. Put your code in a child theme's functions.php or a code-snippets plugin, never in the plugin's own files, because updates overwrite them.
// Run your own code when CartRevival fires an action
add_action( 'cartrevival_apply_flow', function( $flow, $preset ) {
// Your code runs here.
}, 10, 2 );
// Change a value CartRevival is about to use
add_filter( 'cartrevival_channels', function( $channels ) {
// Change $channels here.
return $channels;
}, 10, 1 );Parts of a name in {braces} are filled in at runtime (for example a post type or field ID). Choose Example on any hook for a ready-to-edit snippet.
All hooks
-
/** * Filter the available recovery channels. */ apply_filters( 'cartrevival_channels', $channels ); -
/** * Allow integrations to suppress tracking for a request. */ apply_filters( 'cartrevival_is_trackable', true ); -
/** * Filter the datacentre verdict for one IP. */ apply_filters( 'cartrevival_bot_is_datacenter_ip', $verdict, $ip ); -
/** * This filter is documented below. */ apply_filters( 'cartrevival_channel_has_template', false, $channel ); -
/** * Filter merge tag replacements. */ apply_filters( 'cartrevival_merge_tags', $replacements, $cart, $context ); -
/** * Name a step on the recovery timeline (Pro's alerts use steps 90+). */ apply_filters( 'cartrevival_step_label', $label, $step ); -
/** * Filter the page-to-primary-tab map. */ apply_filters( 'cartrevival_admin_groups', $groups ); -
/** * Filter the notices a ?cr_notice= key can show. */ apply_filters( 'cartrevival_admin_notices', $messages ); -
/** * Filter the admin notification recipient. */ apply_filters( 'cartrevival_admin_notification_recipient', $to ); -
/** * Filter a primary destination's secondary sections. PRO inserts Web Push * under Campaigns, and Integrations + License under Settings. */ apply_filters( 'cartrevival_admin_subtabs', $subtabs, $primary, $page ); -
/** * Filter the admin tabs. Pro appends the License tab here. */ apply_filters( 'cartrevival_admin_tabs', $tabs ); -
/** * Let Pro mirror the preset onto its own step matrix. */ do_action( 'cartrevival_apply_flow', $flow, $preset ); -
/** * Filter the capture-time bot verdict. */ apply_filters( 'cartrevival_blocks_capture', $no_footprint, $ip, $uid, $session ); -
/** * Add more booster cards. Each card must be its own <form>. */ do_action( 'cartrevival_boosters_cards' ); -
/** * Filter the bot user-agent blocklist. */ apply_filters( 'cartrevival_bot_blocklist', $list ); -
/** * Filter the datacentre CIDR list. */ apply_filters( 'cartrevival_bot_datacenter_ranges', $ranges ); -
/** * Filter the declared-crawler substrings. */ apply_filters( 'cartrevival_bot_declared_agents', $needles ); -
/** * Filter the automation-tool substrings. */ apply_filters( 'cartrevival_bot_headless_agents', $needles ); -
/** * Filter the final verdict for a session. */ apply_filters( 'cartrevival_bot_verdict', array( 'score' => $score, 'label' => $label, 'signals' => $signals, ), $facts ); -
/** * Filter the bot-signal weights. */ apply_filters( 'cartrevival_bot_weights', $weights ); -
/** * Filter the URL-button recovery-link bridge. */ apply_filters( 'cartrevival_button_link_enabled', true ); -
/** * Filter the reserved path segments a button token may never occupy. */ apply_filters( 'cartrevival_button_link_reserved_slugs', $reserved, $segment ); -
/** * Fires before a URL-button token restores a cart. */ do_action( 'cartrevival_button_link_restoring', $cart ); -
/** * Filter the per-SKU checkout URL. */ apply_filters( 'cartrevival_buy_url', $url, $sku, $source ); -
/** * Fires when a cart is written off as abandoned. Pro attaches its own * multi-step, multi-channel series here. */ do_action( 'cartrevival_cart_abandoned', $cart ); -
/** * Fires after an order has been attributed to a cart. */ do_action( 'cartrevival_cart_converted', $cart, $order, $was_reminded ); -
/** * Extra chips after the customer name (add-ons; Pro adds VIP). Must return * escaped HTML. */ apply_filters( 'cartrevival_carts_customer_chips', '', $item ); -
/** * Adjust the Carts list query (add-ons; Pro adds the VIP filter). */ apply_filters( 'cartrevival_carts_list_args', $args ); -
/** * Map a custom sort key to an ORDER BY expression (add-ons only). The returned * SQL must be a constant expression built by the add-on, never from request * input; $args['orderby'] is only the key to match on. */ apply_filters( 'cartrevival_carts_query_orderby', $orderby, (string) $args['orderby'] ); -
/** * Render a cell for a column added through cartrevival_carts_table_columns. * The returned HTML must already be escaped. */ apply_filters( 'cartrevival_carts_table_column', $html, $item, $column_name ); -
/** * Filter the Carts list columns. Add-ons render their cells through * cartrevival_carts_table_column. */ apply_filters( 'cartrevival_carts_table_columns', $columns ); -
/** * Filter the sortable Carts list columns. A custom key must also be mapped to * SQL through cartrevival_carts_query_orderby. */ apply_filters( 'cartrevival_carts_table_sortable_columns', $sortable ); -
/** * Whether a channel this plugin does not implement can send. */ apply_filters( 'cartrevival_channel_configured', false, $channel ); -
/** * Filter the screen that connects a channel. */ apply_filters( 'cartrevival_channel_connect_url', $url, $channel ); -
/** * Filter the screen that switches a channel on. */ apply_filters( 'cartrevival_channel_enable_url', $url, $channel ); -
/** * Whether a channel this plugin does not implement is switched on. */ apply_filters( 'cartrevival_channel_enabled', false, $channel ); -
/** * Whether a component owning its own screen has this channel switched on. */ apply_filters( 'cartrevival_channel_enabled_elsewhere', false, $channel ); -
/** * Filter the recovery channel preference order. */ apply_filters( 'cartrevival_channel_priority_order', array( 'email', 'whatsapp', 'sms', 'push' ) ); -
/** * Filter a channel's canonical status. */ apply_filters( 'cartrevival_channel_status', $status, $status['channel'] ); -
/** * Whether another component draws this channel's on/off switch, and so owns it * outright. */ apply_filters( 'cartrevival_channel_switch_owned_elsewhere', false, $channel ); -
/** * Fires the first time contact details are captured for a cart. */ do_action( 'cartrevival_contact_captured', $cart_id, $update ); -
/** * How many reminders one contact (same email or same phone) may get across ALL * of their carts in a rolling seven days. Return 0 to switch the cap off. */ apply_filters( 'cartrevival_contact_weekly_cap', self::WEEKLY_CAP ); -
/** * Backoff delays, in seconds, for a send whose worker crashed. */ apply_filters( 'cartrevival_crash_retry_delays', array( 300, 900, 2700 ), $channel ); -
/** * Extension point for add-ons with their own daily housekeeping. */ do_action( 'cartrevival_daily_maintenance_tasks' ); -
/** * Filter the default email series. */ apply_filters( 'cartrevival_default_email_steps', $steps ); -
/** * Filter the logo shown at the top of CartRevival emails. */ apply_filters( 'cartrevival_email_logo_url', $url ); -
/** * Filter the final subject of a recovery email, just before it is sent. Pro's * subject-line A/B test answers here. */ apply_filters( 'cartrevival_email_subject', $subject, $cart, $step ); -
/** * Fires after an event is written to the raw stream. */ do_action( 'cartrevival_event_logged', $type, $row ); -
/** * Retention window for the raw event log. */ apply_filters( 'cartrevival_event_retention_days', 90 ); -
/** * Filter the directories checked for write access. */ apply_filters( 'cartrevival_filesystem_health_paths', $paths ); -
/** * Extra lines for the "preset activated" notice (Pro adds per-step WhatsApp * template reminders here). */ apply_filters( 'cartrevival_flow_applied_notes', array(), $cartrevival_just_flow ); -
/** * Filter whether a preset channel is ready to deliver. */ apply_filters( 'cartrevival_flow_channel_ready', $ready, $channel ); -
/** * Filter where a preset sends the merchant to connect a channel. */ apply_filters( 'cartrevival_flow_connect_url', \CartRevival\Channel_Status::connect_url( $channel ), $channel ); -
/** * Filter the prebuilt flows offered on the Recovery page. */ apply_filters( 'cartrevival_flow_presets', $presets ); -
/** * Let Pro add its step matrix to the fingerprint. */ apply_filters( 'cartrevival_flow_signature', $parts ); -
/** * Filter the free-shipping goal. */ apply_filters( 'cartrevival_free_shipping_goal', $best ); -
/** * Filter the frontend configuration payload. */ apply_filters( 'cartrevival_frontend_config', $config ); -
/** * Filter the lazy storefront modules. The PRO add-on registers its web push * module through this filter. */ apply_filters( 'cartrevival_frontend_modules', $modules ); -
/** * City lookup is not provided by WooCommerce's free database. Pro (and * merchants running MaxMind City) can supply it here; it wins over the remote * provider's city when set. */ apply_filters( 'cartrevival_geo_city', '', $ip ); -
/** * The IP intelligence endpoint. Must accept the IP as a path segment and * return JSON with countryCode/city/hosting/proxy fields (ip-api.com's shape). * Swap it for a paid or self-hosted provider through this filter. */ apply_filters( 'cartrevival_geo_provider_url', 'http://ip-api.com/json/%s?fields=status,countryCode,city,hosting,proxy' ); -
/** * Allow the remote fallback to be switched off in code as well, for hosts that * must guarantee no visitor IP ever leaves the server regardless of what the * setting says. */ apply_filters( 'cartrevival_geo_remote_enabled', true, $ip ); -
/** * Whether the Pro Insights screen may render. CartRevival Pro answers with its * licence check. */ apply_filters( 'cartrevival_insights_unlocked', false ); -
/** * Requests per minute accepted from one IP address on the public tracking and * capture endpoints. 0 disables the address bucket. */ apply_filters( 'cartrevival_ip_rate_limit', self::IP_RATE_LIMIT ); -
/** * Filter whether housekeeping may run on this request. */ apply_filters( 'cartrevival_is_maintenance_context', $is ); -
/** * Lets Pro swap the flat map for the interactive globe. */ apply_filters( 'cartrevival_live_map', false, $cartrevival_snapshot ); -
/** * Short-circuit the Live monitor's manual send. */ apply_filters( 'cartrevival_live_send_now', null, $cart, $channel ); -
/** * Filter whether the Live tab may use Server-Sent Events. */ apply_filters( 'cartrevival_live_sse_enabled', true ); -
/** * Annotate one Live visitor before it ships to the client. */ apply_filters( 'cartrevival_live_visitor', $visitor, $row ); -
/** * Fires once all Free services are registered. The Pro add-on hooks here to * layer its own services on top. */ do_action( 'cartrevival_loaded', $this ); -
/** * Filter manual-send channel states. An add-on that registered its own channel * through cartrevival_manual_channels resolves that channel's state here. */ apply_filters( 'cartrevival_manual_channel_states', $states, $cart ); -
/** * Filter the manual-send channels. */ apply_filters( 'cartrevival_manual_channels', array( 'email', 'whatsapp' ) ); -
/** * Filter the manual-nudge email template. */ apply_filters( 'cartrevival_manual_email_template', $template ); -
/** * Let an add-on channel describe what its manual send will say. */ apply_filters( 'cartrevival_manual_preview_entry', $entry, $cart, $channel, (int) $step ); -
/** * Hours after a send on the same channel during which a manual send shows a * "recently contacted" warning. */ apply_filters( 'cartrevival_manual_send_cooldown_hours', 12 ); -
/** * Manual sends allowed per user per five minutes. */ apply_filters( 'cartrevival_manual_send_rate_limit', 15 ); -
/** * Filter the automation steps a manual send walks before it falls through to * the manual-nudge step. An add-on that schedules a channel on its own series * answers here so a manual send claims the same slot the automation would have * used. */ apply_filters( 'cartrevival_manual_send_series', $series, $channel, (int) $cart_id ); -
/** * Filter the manual-send target for an add-on channel. */ apply_filters( 'cartrevival_manual_send_target', '', $cart, $channel ); -
/** * Filter the "did you mean" map for unknown merge tags. */ apply_filters( 'cartrevival_merge_tag_aliases', $aliases ); -
/** * Whether CartRevival may wake a late Action Scheduler queue. */ apply_filters( 'cartrevival_nudge_queue', true ); -
/** * Kill switch: turn normalization off entirely. */ apply_filters( 'cartrevival_phone_normalization_enabled', true, $raw, $context ); -
/** * Filter the 6rsh API base URL (staging etc.). */ apply_filters( 'cartrevival_pro_6rsh_api_url', $base ); -
/** * Filter the name of the credential a channel is waiting for. */ apply_filters( 'cartrevival_pro_channel_needs', __( 'its credentials', 'cartrevival' ), $channel ); -
/** * Filter the tags offered by the inserter. */ apply_filters( 'cartrevival_pro_inserter_tags', $tags ); -
/** * Filter the Pro checkout URL. */ apply_filters( 'cartrevival_pro_url', $url, $source ); -
/** * Fires when the purchase guard closes a cart because its shopper already * bought. */ do_action( 'cartrevival_purchase_guard_closed', $cart, $order ); -
/** * Filter the order statuses that count as a purchase for the guard. */ apply_filters( 'cartrevival_purchase_guard_statuses', $statuses ); -
/** * Adjust when a reminder is queued for. Can only move it later. */ apply_filters( 'cartrevival_queue_send_timestamp', $planned, (int) $cart_id, (string) $channel, (int) $step ); -
/** * How long a deleted cart's visitor stays un-recapturable, in seconds. */ apply_filters( 'cartrevival_recapture_suppression_seconds', 6 * HOUR_IN_SECONDS ); -
/** * Fires when a cart is abandoned but held out of recovery. */ do_action( 'cartrevival_recovery_blocked', $cart, $state ); -
/** * Days of recovery history to keep. 0 keeps everything. */ apply_filters( 'cartrevival_recovery_log_retention_days', 90 ); -
/** * Fires when an abandoned cart is recovered-eligible but sending is not armed * yet. */ do_action( 'cartrevival_recovery_not_armed', $cart ); -
/** * Space for Pro's sending-paused notice, kept above everything else. */ do_action( 'cartrevival_recovery_notices' ); -
/** * Pro renders every channel panel here, inside its ONE settings form. Panels * use id="cartrevival-rpanel-{key}" and the shared tab JS. The second argument * is the resolved tab states, so a channel overview can show exactly what the * tabs show. */ do_action( 'cartrevival_recovery_panels', array_keys( $cartrevival_channel_tabs ), $cartrevival_channel_tabs ); -
/** * Filter the Recovery page channel tabs. */ apply_filters( 'cartrevival_recovery_tabs', $cartrevival_channel_tabs ); -
/** * Filter the timeline nodes shown at the top of the Recovery page. */ apply_filters( 'cartrevival_recovery_timeline', $cartrevival_nodes ); -
/** * Filter the recovery verdict for an abandoned cart. */ apply_filters( 'cartrevival_recovery_verdict', $state, $cart ); -
/** * Conditional blocks such as {if coupon}...{/if} are a Pro feature. */ apply_filters( 'cartrevival_render_conditionals', $rendered, $cart, $context ); -
/** * Render the Pro Insights screen. */ do_action( 'cartrevival_render_insights', in_array( $days, array( 7, 30, 90 ), true ) ? $days : 30 ); -
/** * Filter where a restored cart lands. Defaults to checkout. */ apply_filters( 'cartrevival_restore_redirect', $restored ? wc_get_checkout_url() : wc_get_cart_url(), $cart ); -
/** * Filter where an expired or already-bought restore link lands. */ apply_filters( 'cartrevival_restore_stale_redirect', $shop ? $shop : wc_get_cart_url(), $cart, $stale ); -
/** * How long a claim may stand before it is treated as crashed. */ apply_filters( 'cartrevival_send_claim_grace', 15 * MINUTE_IN_SECONDS ); -
/** * A reminder was queued. */ do_action( 'cartrevival_send_queued', (int) $cart_id, (string) $channel, (int) $step, (int) $timestamp, $planned ); -
/** * Backoff delays, in seconds, for retryable send failures. */ apply_filters( 'cartrevival_send_retry_delays', array( 300, 1800, 7200, 28800 ), $channel ); -
/** * Filter whether automated recovery sends are armed. */ apply_filters( 'cartrevival_sending_armed', $armed ); -
/** * Claim ownership of the recovery send schedule. */ apply_filters( 'cartrevival_sending_owner', false ); -
/** * A licensed PRO renders the Connections signpost here: one row per channel, * each linking to the SINGLE page where it is edited. */ do_action( 'cartrevival_settings_connections' ); -
/** * Filter what CartRevival considers already known about this shopper. */ apply_filters( 'cartrevival_shopper_known', self::$known ); -
/** * Filter the locale one message renders in. */ apply_filters( 'cartrevival_shopper_locale', $locale, $cart ); -
/** * Filter whether the CartRevival frontend script loads on this request. */ apply_filters( 'cartrevival_should_load_frontend', $load ); -
/** * Supply the 6rsh connection without the 6rsh plugin being present. */ apply_filters( 'cartrevival_sixrsh_get_connection', null ); -
/** * Whether to remove merge tags that resolved to nothing. */ apply_filters( 'cartrevival_strip_unknown_merge_tags', true ); -
/** * Filter the Dashboard support card: '' hides it, 'review' shows only the * review link, 'full' adds the Pro and share links. */ apply_filters( 'cartrevival_support_card_mode', $mode ); -
/** * Filter the telemetry endpoint. */ apply_filters( 'cartrevival_telemetry_url', untrailingslashit( $base ) . '/telemetry' ); -
/** * Text for a timeline event this plugin does not label itself. */ apply_filters( 'cartrevival_timeline_event_text', $text, $row ); -
/** * Fires when a shopper unsubscribes from cart reminders. */ do_action( 'cartrevival_unsubscribed', $cart ); -
/** * Whether to warn about merge tags that resolve to nothing. */ apply_filters( 'cartrevival_warn_unknown_merge_tags', true ); -
/** * Extra sections in the weekly summary (Pro adds its Insights highlights). * Must return escaped HTML. */ apply_filters( 'cartrevival_weekly_report_extra', '', $d ); -
/** * A parked WhatsApp flow intent was just activated by a new connection. */ do_action( 'cartrevival_whatsapp_activated' ); -
/** * Filter the default variable mapping for a template. */ apply_filters( 'cartrevival_whatsapp_variable_defaults', $map, $spec ); -
/** * Filter the tokens offered for WhatsApp variable mapping. */ apply_filters( 'cartrevival_whatsapp_variable_tokens', $tokens, $with_coupon ); -
/** * Filter the reply shown after a shopper picks an exit reason. */ apply_filters( 'cartrevival_why_reply', $text, $reason ); -
/** * This filter is documented in wp-includes/class-wp-http-streams.php */ apply_filters( 'https_local_ssl_verify', false ); -
/** * This filter is documented in wp-includes/l10n.php */ apply_filters( 'plugin_locale', $locale, 'cartrevival' ); -
apply_filters( 'cartrevival_6rsh_signup_url', add_query_arg( array( 'utm_source' => 'cartrevival', 'utm_medium' => 'plugin', 'utm_campaign' => 'whatsapp_free', 'utm_content' => sanitize_key( $source ), ), 'https://6rsh.com/' ), $source ); -
apply_filters( 'cartrevival_connections_signpost', false ); -
do_action( 'cartrevival_dashboard_attribution', $range ); -
apply_filters( 'cartrevival_low_stock_threshold', self::LOW_STOCK ); -
apply_filters( 'cartrevival_pro_installed', false ); -
apply_filters( 'cartrevival_quiet_hours_channels', array( 'whatsapp', 'sms', 'push' ) ); -
apply_filters( 'cartrevival_recaptcha_threshold', 0.5 ); -
apply_filters( 'cartrevival_restore_max_age_days', 60, $cart ); -
apply_filters( "cartrevival_send_{$channel}", null, $cart, (int) $step ); -
apply_filters( 'cartrevival_send_email', null, Carts::get( $cart_id ), 1 ); -
apply_filters( 'cartrevival_trusted_proxies', array() ); -
apply_filters( 'cartrevival_welcome_back', 'yes' === self::settings()['welcome_back'], $cart ); -
do_action( 'litespeed_control_set_nocache', 'CartRevival cart restore' ); -
apply_filters( 'woocommerce_cookie', 'wp_woocommerce_session_' . COOKIEHASH );
Generated from CartRevival's GPL-licensed source code. Hooks inside bundled third-party libraries are not listed.
Done for you
Rather have it built for you?
Tell us what should change and we’ll write and test the code using these hooks.
Custom hook snippet
from $49
A small, update-safe change built on the plugin’s own hooks.
- Code written against the plugin’s actions and filters
- Tested on a staging copy of your site
- Install instructions included
Typical turnaround: 2–3 business days
Choose thisPlugin customisation
from $149
New features or changed behaviour, without editing the plugin’s files.
- Built as a companion plugin, so updates never wipe it
- Exact quote before we start
- Tested on staging, then deployed
Typical turnaround: 3–7 business days
Choose thisNot sure which fits? Describe what you need and we’ll suggest the simplest option.
Can't find the right hook?
We can build the customisation for you. Describe what you need: