WooPayments: Integrated WooCommerce Payments 11.3.0 has 29 actions and 99 filters, read directly from its source code on Nov 17, 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 WooPayments: Integrated WooCommerce Payments fires an action
add_action( 'woocommerce_email_order_details', function( $order, $sent_to_admin, $plain_text, $email ) {
// Your code runs here.
}, 10, 4 );
// Change a value WooPayments: Integrated WooCommerce Payments is about to use
add_filter( 'woocommerce_email_footer_text', function( $woocommerce_email_footer_text ) {
// Change $woocommerce_email_footer_text here.
return $woocommerce_email_footer_text;
}, 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
-
/** * Shows the order details table. */ do_action( 'woocommerce_email_order_details', $order, $sent_to_admin, $plain_text, $email ); -
/** * Shows order meta data. */ do_action( 'woocommerce_email_order_meta', $order, $sent_to_admin, $plain_text, $email ); -
/** * Output the email header. */ do_action( 'woocommerce_email_header', $email_heading, $email ); -
/** * Allows filtering of the arguments sent when fetching onboarding data. */ apply_filters( 'wc_payments_get_onboarding_data_args', [ 'return_url' => $return_url, 'site_data' => $site_data, 'user_data' => $user_data, 'account_data' => $account_data, 'actioned_notes' => $actioned_notes, 'create_live_account' => $live_account, 'collect_payout_requirements' => $collect_payout_requirements, ] ); -
/** * Allows filtering of the headers sent with a WooPayments API request. */ apply_filters( 'wcpay_api_request_headers', [ 'Content-type' => 'application/json; charset=utf-8', ] ); -
/** * Shows customer details, and email address. */ do_action( 'woocommerce_email_customer_details', $order, $sent_to_admin, $plain_text, $email ); -
/** * Output the compliance details section of the IPP receipt email. */ do_action( 'woocommerce_payments_email_ipp_receipt_compliance_details', $charge, $plain_text ); -
/** * Output the store details section of the IPP receipt email. */ do_action( 'woocommerce_payments_email_ipp_receipt_store_details', $merchant_settings, $plain_text ); -
/** * Fires when the customer opts to save their account with WooPay. */ do_action( 'woocommerce_payments_save_user_in_woopay' ); -
/** * Fires once the customer data has been localized, to guard against duplicate * localization. */ do_action( '__wcpay_customer_data_localized' ); -
/** * Fires once the UPE config has been localized, to guard against duplicate * localization. */ do_action( '__wcpay_upe_config_localized' ); -
/** * Filters whether the Multi-Currency JOIN clauses modification should be * disabled. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}disable_filter_join_clauses", false ); -
/** * Filters whether the Multi-Currency SELECT clauses modification should be * disabled. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}disable_filter_select_clauses", false ); -
{MultiCurrency::FILTER_PREFIX}disable_filter_select_orders_clauses
filter Copy link Customise this hook/** * Filters whether the Multi-Currency SELECT orders clauses modification should * be disabled. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}disable_filter_select_orders_clauses", false ); -
/** * Filters whether the Multi-Currency WHERE clauses modification should be * disabled. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}disable_filter_where_clauses", false ); -
/** * Filters the JOIN clauses after the Multi-Currency currency JOINs have been * added. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}filter_join_clauses", $clauses ); -
/** * Filters the SELECT clauses after the Multi-Currency columns have been added. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}filter_select_clauses", $new_clauses ); -
/** * Filters the SELECT orders clauses after Multi-Currency conversions have been * applied. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}filter_select_orders_clauses", $clauses ); -
/** * Filters the WHERE clauses after Multi-Currency customer currency filtering * has been applied. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}filter_where_clauses", $clauses ); -
/** * Filters the currency code that should override the selected currency. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}override_selected_currency", false ); -
/** * Filters whether a coupon's amount should be converted to the selected * currency. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}should_convert_coupon_amount", true, $coupon ); -
{MultiCurrency::FILTER_PREFIX}should_convert_coupon_min_max_amount
filter Copy link Customise this hook/** * Filters whether a coupon's minimum and maximum amounts should be converted * to the selected currency. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}should_convert_coupon_min_max_amount", true, $coupon ); -
/** * Filters whether a product's price should be converted to the selected * currency. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}should_convert_product_price", true, $product ); -
/** * Filters whether a shipping rate's cost should be converted to the selected * currency. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}should_convert_shipping_amount", true, $shipping_method ); -
{MultiCurrency::FILTER_PREFIX}should_disable_currency_switching
filter Copy link Customise this hook/** * Filters whether currency switching (widgets and automatic geolocation * switching) should be disabled. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}should_disable_currency_switching", $return ); -
/** * Filters whether the currency switcher widgets should be hidden. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}should_hide_widgets", $return ); -
/** * Filters whether the store's default currency should be returned instead of * the selected currency. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}should_return_store_currency", false ); -
/** * Filters the args passed to the Storefront currency switcher widget. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}storefront_widget_args", [ 'before_widget' => '<div id="woocommerce-payments-multi-currency-storefront-widget" class="woocommerce-breadcrumb">', 'after_widget' => '</div>', ] ); -
/** * Filters the CSS applied to the Storefront currency switcher widget. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}storefront_widget_css", $css ); -
/** * Filters the instance settings passed to the Storefront currency switcher * widget. */ apply_filters( "{MultiCurrency::FILTER_PREFIX}storefront_widget_instance", [] ); -
/** * Filters whether charm pricing should only be applied to products. */ apply_filters( "{self::FILTER_PREFIX}apply_charm_only_to_products", true ); -
/** * Filter the available currencies for WooCommerce Multi-Currency. */ apply_filters( "{self::FILTER_PREFIX}available_currencies", array_intersect( $account_currencies, $wc_currencies ) ); -
/** * Filters the country name shown in the currency switch notice. */ apply_filters( "{self::FILTER_PREFIX}override_notice_country", WC()->countries->countries[ $country ] ); -
/** * Filters the currency name shown in the currency switch notice. */ apply_filters( "{self::FILTER_PREFIX}override_notice_currency_name", $currency->get_name() ); -
/** * Filters the args passed to the currency switcher theme widget. */ apply_filters( "{self::FILTER_PREFIX}theme_widget_args", $args ); -
/** * Filters the instance settings passed to the currency switcher theme widget. */ apply_filters( "{self::FILTER_PREFIX}theme_widget_instance", $instance ); -
/** * Filters the account ID used for payment intent confirmation. */ apply_filters( 'wc_payments_account_id_for_intent_confirmation', '' ); -
/** * Fires to render the UPE payment fields on the checkout page. */ do_action( 'wc_payments_add_upe_payment_fields' ); -
/** * Allows replacing the API client class used for WooPayments API requests. */ apply_filters( 'wc_payments_api_client', WC_Payments_API_Client::class ); -
/** * Filters whether to display the "save payment method" checkbox. */ apply_filters( 'wc_payments_display_save_payment_method_checkbox', $display_tokenization ); -
/** * Allows replacing the HTTP client used for WooPayments API requests. */ apply_filters( 'wc_payments_http', null ); -
/** * Filters the text shown next to the "save payment method" checkbox at * checkout. */ apply_filters( 'wc_payments_save_to_account_text', __( 'Save payment information to my account for future purchases.', 'woocommerce-payments' ) ); -
/** * Fires to set the gateway for the UPE payment fields. */ do_action( 'wc_payments_set_gateway', $this->get_selected_stripe_payment_type_id() ); -
/** * Filters the payment method logo URL shown on the thank you page for local * payment methods. */ apply_filters( 'wc_payments_thank_you_page_lpm_payment_method_logo_url', $method_logo_url, $payment_method->get_id() ); -
/** * Filter to edit formatting for a specific currency * (wcpay_{currency_code}_format). */ apply_filters( "wcpay_{strtolower($currency_code)}_format", $currency_format, $locale ); -
/** * Allows filtering of the parameters sent with a WooPayments API request. */ apply_filters( 'wcpay_api_request_params', $params, $api, $method ); -
/** * Allows filtering of the raw response returned from a WooPayments API * request. */ apply_filters( 'wcpay_api_request_response', $response, $method, $url, $api ); -
/** * Filters the calculated total for the Express Checkout request. */ apply_filters( 'wcpay_calculated_total', WC_Payments_Utils::prepare_amount( $order_total, $currency ), $order_total, WC()->cart ); -
/** * Filters whether the order payment can be confirmed without a payment intent. */ apply_filters( 'wcpay_confirm_without_payment_intent', ! $payment_needed && ! $save_payment_method_to_store ); -
/** * Filters the order statuses for which a customer should not be created from * an order. */ apply_filters( 'wcpay_create_customer_disallowed_order_statuses', [ Order_Status::COMPLETED, Order_Status::CANCELLED, Order_Status::REFUNDED, Order_Status::FAILED, ] ); -
/** * Used for unit tests only, as requests have dependencies, which are not * publicly available in live mode. */ apply_filters( 'wcpay_create_request', null, $class_name, $id ); -
/** * Allows filtering of the time-to-live (in seconds) for a WooPayments database * cache entry. */ apply_filters( 'wcpay_database_cache_ttl', $ttl, $key, $cache_contents ); -
/** * Allows WooPayments to enter dev (aka sandbox) mode. */ apply_filters( 'wcpay_dev_mode', $dev_mode ); -
/** * Filters whether the new onboarding flow should be disabled. */ apply_filters( 'wcpay_disable_new_onboarding', defined( 'WCPAY_DISABLE_NEW_ONBOARDING' ) && WCPAY_DISABLE_NEW_ONBOARDING ); -
/** * Filters the express checkout JS params, allowing some specific configuration * to be tweaked by 3pd. */ apply_filters( 'wcpay_express_checkout_js_params', [ 'ajax_url' => admin_url( 'admin-ajax.php' ), 'wc_ajax_url' => WC_AJAX::get_endpoint( '%%endpoint%%' ), 'nonce' => [ 'platform_tracker' => wp_create_nonce( 'platform_tracks_nonce' ), 'tokenized_cart_nonce' => wp_create_nonce( WC_Payments_Express_Checkout_Button_Helper::TOKENIZED_CART_NONCE_ACTION ), 'tokenized_cart_session_nonce' => wp_create_nonce( WC_Payments_Payment_Request_Session::TOKENIZ... ); -
/** * Filters the `setup_future_usage` express checkout mints its * ConfirmationToken with. */ apply_filters( 'wcpay_express_checkout_setup_future_usage', $will_be_saved ? 'off_session' : null, $context ); -
/** * Allows forcing WooPayments to use network-wide saved payment methods across * a multisite network. */ apply_filters( 'wcpay_force_network_saved_cards', false ); -
/** * Filters the front-end tracks events to register. */ apply_filters( 'wcpay_frontend_tracks', [] ); -
/** * Filters the URL to redirect to after a payment method is added. */ apply_filters( 'wcpay_get_add_payment_method_redirect_url', wc_get_endpoint_url( 'payment-methods' ) ); -
/** * Allows filtering of whether WCPay Subscriptions is enabled. */ apply_filters( 'wcpay_is_wcpay_subscriptions_enabled', '1' === get_option( self::WCPAY_SUBSCRIPTIONS_FLAG_NAME, '0' ) ); -
/** * Filters whether the WooPay email input hooks should be enabled. */ apply_filters( 'wcpay_is_woopay_email_input_enabled', true ); -
/** * Filter the WCPay JS settings. */ apply_filters( 'wcpay_js_settings', $this->wcpay_js_settings ); -
/** * Filters the localized, customer-facing Stripe error messages. */ apply_filters( 'wcpay_localized_messages', [ 'invalid_number' => __( 'The card number is not a valid credit card number.', 'woocommerce-payments' ), 'invalid_expiry_month' => __( 'Your card\'s expiration month is invalid.', 'woocommerce-payments' ), 'invalid_expiry_year' => __( 'Your card\'s expiration year is invalid.', 'woocommerce-payments' ), 'invalid_cvc' => __( 'Your card\'s security code is invalid.', 'woocommerce-payments' ), 'i... ); -
/** * Filters the URL query keys whose values are kept in log entries. Only * include keys with non-sensitive values. */ apply_filters( 'wcpay_logger_context_url_query_keys_to_keep', self::URL_QUERY_KEYS_TO_KEEP ); -
/** * Filters the payment metadata generated from an order before it is sent to * the server. */ apply_filters( 'wcpay_metadata_from_order', [ 'customer_email' => $order->get_billing_email(), ], $order ); -
/** * Filters the price type used by the async renderer. */ apply_filters( 'wcpay_multi_currency_async_price_type', 'product', $price, $args ); -
/** * Filters whether the site is considered to run full-page caching. */ apply_filters( 'wcpay_multi_currency_page_caching_active', $is_active ); -
/** * Filters whether the explicit price (currency code suffix) should be * displayed alongside the currency symbol on total amounts. */ apply_filters( 'wcpay_multi_currency_should_output_explicit_price', $should_output_explicit_price ); -
/** * Hook: When the order meta data _intent_id is updated. */ do_action( 'wcpay_order_intent_id_updated' ); -
/** * Hook: When the order meta data _payment_method_id is updated. */ do_action( 'wcpay_order_payment_method_id_updated' ); -
/** * Allows filtering of the JS config for the payment fields. */ apply_filters( 'wcpay_payment_fields_js_config', $payment_fields ); -
/** * Fires after the UPE payment fields have been rendered. */ do_action( 'wcpay_payment_fields_upe', $this->gateway->id ); -
/** * Filters the locale used for the express checkout (payment request) button. */ apply_filters( 'wcpay_payment_request_button_locale', substr( get_locale(), 0, 2 ) ); -
/** * Filters whether to hide itemization and show only the subtotal in Express * Checkout. */ apply_filters( 'wcpay_payment_request_hide_itemization', ! $itemized_display_items ); -
/** * Filter whether product supports Express Checkout Element Button on cart * page. */ apply_filters( 'wcpay_payment_request_is_cart_supported', true, $_product ); -
/** * Filters whether the current product is supported for Express Checkout. */ apply_filters( 'wcpay_payment_request_is_product_supported', $is_supported, $product ); -
/** * Filters the Level 3 data based on order. */ apply_filters( 'wcpay_payment_request_level3_data', $level3_data, $order ); -
/** * Filters the suffix appended to the express checkout payment method title. */ apply_filters( 'wcpay_payment_request_payment_method_title_suffix', 'WooPayments' ); -
/** * Filters the product data sent to the Express Checkout request. */ apply_filters( 'wcpay_payment_request_product_data', $data, $product ); -
/** * Filters the product types supported by Express Checkout. */ apply_filters( 'wcpay_payment_request_supported_types', [ 'simple', 'variable', 'variation', 'subscription', 'variable-subscription', 'subscription_variation', 'booking', 'bundle', 'composite', 'mix-and-match', ] ); -
/** * Filters the label shown for the order total in the Express Checkout request. */ apply_filters( 'wcpay_payment_request_total_label', $this->get_total_label() ); -
/** * Filters the suffix appended to the Express Checkout total label. */ apply_filters( 'wcpay_payment_request_total_label_suffix', ' (via WooCommerce)' ); -
/** * Filters whether the WooPay Express button supports all of the items * currently in the cart. */ apply_filters( 'wcpay_platform_checkout_button_are_cart_items_supported', $is_supported ); -
/** * Filter the plugins page settings. */ apply_filters( 'wcpay_plugins_page_js_settings', $plugins_page_settings ); -
/** * Filters the fraud service configuration before it is sent to the client. */ apply_filters( 'wcpay_prepare_fraud_config', $config, $service_id ); -
/** * Filters whether shopper tracking is enabled. */ apply_filters( 'wcpay_shopper_tracking_enabled', 'no' !== get_option( 'woocommerce_allow_tracking', '' ) ); -
/** * Filters whether a payment for an already-paid order should be prevented. */ apply_filters( 'wcpay_should_prevent_payment_for_paid_order', true, $order, $status ); -
/** * Filters the subscription data prepared for creating a WCPay subscription. */ apply_filters( 'wcpay_subscriptions_prepare_subscription_data', $data ); -
/** * Filters the order status value after a successful terminal payment. */ apply_filters( 'wcpay_terminal_payment_completed_order_status', Order_Status::COMPLETED ); -
/** * Allows WooPayments to process payments in test mode. */ apply_filters( 'wcpay_test_mode', $test_mode ); -
/** * Allows WooPayments to use test mode onboarding. */ apply_filters( 'wcpay_test_mode_onboarding', $test_mode_onboarding ); -
/** * Filters the properties recorded with a Tracks event. */ apply_filters( 'wcpay_tracks_event_properties', $properties, $event_name ); -
/** * Fires after a payment error so the result can be updated. */ do_action( 'wcpay_update_payment_result_on_error', $e, $order ); -
/** * Filters the list of available UPE payment methods. */ apply_filters( 'wcpay_upe_available_payment_methods', $available_methods ); -
/** * Filters whether the WooPay Express button supports the given product. */ apply_filters( 'wcpay_woopay_button_is_product_supported', $is_supported, $product ); -
/** * Allows 3PD to programmatically show/hide the WooPay button. */ apply_filters( 'wcpay_woopay_enabled', $this->is_woopay_eligible && $this->is_woopay_enabled && $this->is_woopay_express_button_enabled ); -
/** * Filters whether the current request is signed with the store's blog token. */ apply_filters( 'wcpay_woopay_is_signed_with_blog_token', Rest_Authentication::is_signed_with_blog_token() ); -
/** * Filters the origins allowed to call the WooPay session AJAX actions. */ apply_filters( 'wcpay_woopay_session_allowed_origins', [ home_url(), admin_url() ] ); -
/** * Filters whether to use the store's blog token secret when connecting to a * custom WooPay URL. */ apply_filters( 'wcpay_woopay_use_blog_token', false ); -
/** * Filter whether WooPayments' Abilities API registrations are active. */ apply_filters( 'woocommerce_payments_abilities_enabled', false ); -
/** * Allow us to tie in functionality to an account refresh. */ do_action( 'woocommerce_payments_account_refreshed', $account ); -
/** * Fires after a WooPayments webhook event has been processed. */ do_action( 'woocommerce_payments_after_webhook_delivery', $event_type, $event_body ); -
/** * Fires before a WooPayments webhook event is processed. */ do_action( 'woocommerce_payments_before_webhook_delivery', $event_type, $event_body ); -
/** * Fires after the payment method for a subscription order has changed. */ do_action( 'woocommerce_payments_changed_subscription_payment_method', $order, $payment_token ); -
/** * Fires when an order fails during payment processing. */ do_action( 'woocommerce_payments_order_failed', $order, $e ); -
/** * A store can declare one of its paid statuses still payable — deposit and * partial-payment extensions do exactly that, collecting the balance through * pay-for-order. Defer to that declaration rather than blocking a payment the * store expects. */ apply_filters( 'woocommerce_valid_order_statuses_for_payment', [ Order_Status::PENDING, Order_Status::FAILED ], $order ); -
/** * Fires so notices can be added to the WooPayments settings page. */ do_action( 'woocommerce_woocommerce_payments_admin_notices' ); -
/** * Allow 3rd-party to trigger some action if needed when a payment requires * action. */ do_action( 'woocommerce_woocommerce_payments_payment_requires_action', $order, $intent_id, $payment_method, $customer_id, $charge_id, $currency ); -
/** * Fires after WooPayments has been updated to a newer version. */ do_action( 'woocommerce_woocommerce_payments_updated' ); -
do_action( 'woocommerce_subscriptions_email_order_details', $order, $sent_to_admin, $plain_text, $email ); -
apply_filters( 'woocommerce_thankyou_order_key', empty( $_GET['key'] ) ? '' : wc_clean( wp_unslash( $_GET['key'] ) ) ); -
apply_filters_deprecated( 'wc_payments_thank_you_page_bnpl_payment_method_logo_url', [ $payment_method->get_icon( $account_country ), $payment_method->get_id(), ], '8.5.0', 'wc_payments_thank_you_page_lpm_payment_method_logo_url' ); -
apply_filters( 'wc_session_expiration', DAY_IN_SECONDS * 2 ); -
apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base ); -
apply_filters( 'woocommerce_add_to_cart_validation', true, $product_id, $quantity ); -
apply_filters( 'woocommerce_addons_add_cart_price_to_value', false, $cart_item ); -
apply_filters( 'woocommerce_addons_add_order_price_to_value', false, $item ); -
apply_filters( 'woocommerce_admin_disabled', false ); -
do_action( 'woocommerce_blocks_checkout_block_registration', $this ); -
apply_filters( 'woocommerce_cart_item_product', $cart_item['data'], $cart_item, $cart_item_key ); -
apply_filters( 'woocommerce_customer_default_location', $default_location ); -
apply_filters( 'woocommerce_order_email_verification_grace_period', 10 * MINUTE_IN_SECONDS, $order ); -
do_action( 'woocommerce_order_status_failed_notification', $order->get_id(), $order ); -
do_action( 'woocommerce_order_status_pending_to_failed_notification', $order->get_id(), $order ); -
do_action( 'woocommerce_refund_deleted', $refund_id, $parent_order_id ); -
apply_filters( 'woocommerce_thankyou_order_id', absint( $wp->query_vars['order-received'] ?? 0 ) );
Generated from WooPayments: Integrated WooCommerce Payments'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: