update: add wcpay_express_checkout_js_params filter (#10824)

Author: frosso

changelog/update-add-filter-for-express-checkout-params

@@ -0,0 +1,4 @@
+Significance: patch
+Type: update
+
+update: add `wcpay_express_checkout_js_params` filter for express checkout JS params.

includes/express-checkout/class-wc-payments-express-checkout-button-handler.php

@@ -218,38 +218,51 @@ public function is_account_creation_possible() {
 	 * @return array Parameters for Express Checkout.
 	 */
 	public function get_express_checkout_params() {
-		return [
-			'ajax_url'           => admin_url( 'admin-ajax.php' ),
-			'wc_ajax_url'        => WC_AJAX::get_endpoint( '%%endpoint%%' ),
-			'stripe'             => [
-				'publishableKey' => $this->account->get_publishable_key( WC_Payments::mode()->is_test() ),
-				'accountId'      => $this->account->get_stripe_account_id(),
-				'locale'         => WC_Payments_Utils::convert_to_stripe_locale( get_locale() ),
-			],
-			'nonce'              => [
-				'platform_tracker'             => wp_create_nonce( 'platform_tracks_nonce' ),
-				// needed to communicate via the Store API.
-				'tokenized_cart_nonce'         => wp_create_nonce( 'woopayments_tokenized_cart_nonce' ),
-				'tokenized_cart_session_nonce' => wp_create_nonce( 'woopayments_tokenized_cart_session_nonce' ),
-				'store_api_nonce'              => wp_create_nonce( 'wc_store_api' ),
-			],
-			'checkout'           => [
-				'currency_code'              => strtolower( get_woocommerce_currency() ),
-				'currency_decimals'          => WC_Payments::get_localization_service()->get_currency_format( get_woocommerce_currency() )['num_decimals'],
-				'country_code'               => substr( get_option( 'woocommerce_default_country' ), 0, 2 ),
-				'needs_shipping'             => WC()->cart->needs_shipping(),
-				// Defaults to 'required' to match how core initializes this option.
-				'needs_payer_phone'          => 'required' === get_option( 'woocommerce_checkout_phone_field', 'required' ),
-				'allowed_shipping_countries' => array_keys( WC()->countries->get_shipping_countries() ?? [] ),
-				'display_prices_with_tax'    => 'incl' === get_option( 'woocommerce_tax_display_cart' ),
-			],
-			'button'             => $this->get_button_settings(),
-			'login_confirmation' => $this->get_login_confirmation_settings(),
-			'button_context'     => $this->express_checkout_helper->get_button_context(),
-			'has_block'          => has_block( 'woocommerce/cart' ) || has_block( 'woocommerce/checkout' ),
-			'product'            => $this->express_checkout_helper->get_product_data(),
-			'store_name'         => get_bloginfo( 'name' ),
-		];
+		/**
+		 * Allowing some specific configuration to be tweaked by 3pd.
+		 *
+		 * @since 9.5.0
+		 */
+		return array_merge(
+			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' ),
+						// needed to communicate via the Store API.
+						'tokenized_cart_nonce'         => wp_create_nonce( 'woopayments_tokenized_cart_nonce' ),
+						'tokenized_cart_session_nonce' => wp_create_nonce( 'woopayments_tokenized_cart_session_nonce' ),
+						'store_api_nonce'              => wp_create_nonce( 'wc_store_api' ),
+					],
+					'checkout'           => [
+						'currency_code'              => strtolower( get_woocommerce_currency() ),
+						'currency_decimals'          => WC_Payments::get_localization_service()->get_currency_format( get_woocommerce_currency() )['num_decimals'],
+						'country_code'               => substr( get_option( 'woocommerce_default_country' ), 0, 2 ),
+						'needs_shipping'             => WC()->cart->needs_shipping(),
+						// Defaults to 'required' to match how core initializes this option.
+						'needs_payer_phone'          => 'required' === get_option( 'woocommerce_checkout_phone_field', 'required' ),
+						'allowed_shipping_countries' => array_keys( WC()->countries->get_shipping_countries() ?? [] ),
+						'display_prices_with_tax'    => 'incl' === get_option( 'woocommerce_tax_display_cart' ),
+					],
+					'button'             => $this->get_button_settings(),
+					'login_confirmation' => $this->get_login_confirmation_settings(),
+					'button_context'     => $this->express_checkout_helper->get_button_context(),
+					'has_block'          => has_block( 'woocommerce/cart' ) || has_block( 'woocommerce/checkout' ),
+					'product'            => $this->express_checkout_helper->get_product_data(),
+					'store_name'         => get_bloginfo( 'name' ),
+				]
+			),
+			[
+				// placing these outside of the filter to prevent modification of the values.
+				'stripe' => [
+					'publishableKey' => $this->account->get_publishable_key( WC_Payments::mode()->is_test() ),
+					'accountId'      => $this->account->get_stripe_account_id(),
+					'locale'         => WC_Payments_Utils::convert_to_stripe_locale( get_locale() ),
+				],
+			]
+		);
 	}
 
 	/**