Introduce wc_stripe_force_save_payment_method filter (#4243)

* introduce wc_stripe_force_save_payment_method filter

* move the filter under the 'should_save_payment_method_from_request' function

* add comments and refactor

* move the method to helper class

* use helper method

* show message about saving pm in shortcode checkout

* show the force save terms on block checkout without showing the checkbox

* add changelog

* Fix bad doc block from merge

* bail if the user is not logged in

* update comment

* apply deprecated filter first

* remove unnecessary if block

---------

Co-authored-by: daledupreez <[email protected]>
Co-authored-by: Dale du Preez <[email protected]>
Co-authored-by: Diego Curbelo <[email protected]>

Author: 3 people

changelog.txt

@@ -43,6 +43,7 @@
 * Tweak - Remove Payment Method Configurations fallback cache
 * Tweak - Update deprecation notice message to specify that legacy checkout experience has been deprecated since version 9.6.0
 * Update - Remove legacy checkout checkbox from settings
+* Add - Introduced `wc_stripe_force_save_payment_method` filter
 * Update - Express Checkout: introduce new WP actions for supporting custom checkout fields for classic, shortcode-based checkout
 * Fix - Fix payment processing for $0 subscription with recurring coupon
 * Dev - Add e2e tests to cover Affirm purchase flow

client/blocks/utils.js

@@ -29,7 +29,9 @@ export const shouldSetupOffSessionPayment = (
 ) => {
 	return (
 		shouldShowSaveOption ||
-		hasAutoRenewingSubscription( isPaymentMethodReusable )
+		hasAutoRenewingSubscription( isPaymentMethodReusable ) ||
+		( isPaymentMethodReusable &&
+			getBlocksConfiguration()?.forceSavePaymentMethod )
 	);
 };
 

includes/class-wc-stripe-helper.php

@@ -1785,6 +1785,44 @@ public static function is_currency_supported_for_indian_recurring_payment_mandat
 		return in_array( strtolower( $currency ), $supported_currencies, true );
 	}
 
+	/**
+	 * Checks if the payment method should be saved.
+	 *
+	 * @since 9.6.0
+	 * @param bool $force_save Whether the payment method should be saved.
+	 * @param string $order_id Order ID.
+	 * @return bool
+	 */
+	public static function should_force_save_payment_method( $force_save = false, $order_id = null ) {
+		// Do not save the payment method if the user is not logged in.
+		if ( ! is_user_logged_in() ) {
+			return false;
+		}
+
+		// Backward compatibility for deprecated 'wc_stripe_force_save_source' filter.
+		$force_save_payment_method = apply_filters_deprecated(
+			'wc_stripe_force_save_source',
+			[ $force_save, $order_id ],
+			'9.6.0',
+			'wc_stripe_force_save_payment_method',
+			'The wc_stripe_force_save_source filter is deprecated since WooCommerce Stripe Gateway 9.6.0. Use wc_stripe_force_save_payment_method instead.'
+		);
+
+		/**
+		 * Filters the flag that decides if the payment method must be saved in all possible situations.
+		 *
+		 * @since 9.6.0
+		 *
+		 * @param bool   $force_save Whether the payment method must be saved.
+		 * @param string $order_id   Order ID.
+		 *
+		 * @return bool Whether the payment method must be saved in all situations.
+		*/
+		$force_save_payment_method = apply_filters( 'wc_stripe_force_save_payment_method', $force_save_payment_method, $order_id );
+
+		return $force_save_payment_method;
+	}
+
 	/**
 	 * Returns the description for a refund reason.
 	 *

includes/payment-methods/class-wc-stripe-upe-payment-gateway.php

@@ -521,6 +521,7 @@ public function javascript_params() {
 		$stripe_params['cartContainsSubscription']          = $this->is_subscription_item_in_cart();
 		$stripe_params['subscriptionRequiresManualRenewal'] = WC_Stripe_Subscriptions_Helper::is_manual_renewal_required();
 		$stripe_params['subscriptionManualRenewalEnabled']  = WC_Stripe_Subscriptions_Helper::is_manual_renewal_enabled();
+		$stripe_params['forceSavePaymentMethod']            = WC_Stripe_Helper::should_force_save_payment_method();
 		$stripe_params['accountCountry']                    = WC_Stripe::get_instance()->account->get_account_country();
 		$stripe_params['isPaymentRequestEnabled']           = $express_checkout_helper->is_payment_request_enabled();
 		$stripe_params['isAmazonPayEnabled']                = $express_checkout_helper->is_amazon_pay_enabled();
@@ -829,7 +830,7 @@ public function payment_fields() {
 			<?php
 			$methods_enabled_for_saved_payments = array_filter( $this->get_upe_enabled_payment_method_ids(), [ $this, 'is_enabled_for_saved_payments' ] );
 			if ( $this->is_saved_cards_enabled() && ! empty( $methods_enabled_for_saved_payments ) ) {
-				$force_save_payment = ( $display_tokenization && ! apply_filters( 'wc_stripe_display_save_payment_method_checkbox', $display_tokenization ) ) || is_add_payment_method_page();
+				$force_save_payment = ( $display_tokenization && ! apply_filters( 'wc_stripe_display_save_payment_method_checkbox', $display_tokenization ) ) || is_add_payment_method_page() || WC_Stripe_Helper::should_force_save_payment_method();
 				$this->save_payment_method_checkbox( $force_save_payment );
 			}
 
@@ -2670,6 +2671,11 @@ private function should_save_payment_method_from_request( $order_id, $payment_me
 			return false;
 		}
 
+		// Save the payment method when forced by the filter.
+		if ( WC_Stripe_Helper::should_force_save_payment_method( false, $order_id ) ) {
+			return true;
+		}
+
 		// For card/stripe, the request arg is `wc-stripe-new-payment-method` and for our reusable APMs (i.e. bancontact) it's `wc-stripe_bancontact-new-payment-method`.
 		$save_payment_method_request_arg = sprintf( 'wc-stripe%s-new-payment-method', WC_Stripe_Payment_Methods::CARD !== $payment_method_type ? '_' . $payment_method_type : '' );
 
@@ -3105,7 +3111,8 @@ private function get_payment_method_types_for_intent_creation(
 	private function should_upe_payment_method_show_save_option( $payment_method ) {
 		if ( $payment_method->is_reusable() ) {
 			// If a subscription in the cart, it will be saved by default so no need to show the option.
-			return $this->is_saved_cards_enabled() && ! $this->is_subscription_item_in_cart() && ! $this->is_pre_order_charged_upon_release_in_cart();
+			// If force save payment method is true, no need to show the option.
+			return $this->is_saved_cards_enabled() && ! $this->is_subscription_item_in_cart() && ! $this->is_pre_order_charged_upon_release_in_cart() && ! WC_Stripe_Helper::should_force_save_payment_method();
 		}
 
 		return false;

includes/payment-methods/class-wc-stripe-upe-payment-method.php

@@ -642,7 +642,7 @@ public function payment_fields() {
 			</fieldset>
 			<?php
 			if ( $this->should_show_save_option() ) {
-				$force_save_payment = ( $display_tokenization && ! apply_filters( 'wc_stripe_display_save_payment_method_checkbox', $display_tokenization ) ) || is_add_payment_method_page();
+				$force_save_payment = ( $display_tokenization && ! apply_filters( 'wc_stripe_display_save_payment_method_checkbox', $display_tokenization ) ) || is_add_payment_method_page() || WC_Stripe_Helper::should_force_save_payment_method();
 				if ( is_user_logged_in() ) {
 					$this->save_payment_method_checkbox( $force_save_payment );
 				}

readme.txt

@@ -155,6 +155,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 * Dev - Add Klarna e2e tests
 * Tweak - Update deprecation notice message to specify that legacy checkout experience has been deprecated since version 9.6.0
 * Update - Remove legacy checkout checkbox from settings
+* Add - Introduced `wc_stripe_force_save_payment_method` filter
 * Update - Express Checkout: introduce new WP actions for supporting custom checkout fields for classic, shortcode-based checkout
 * Fix - Fixes page crash when Klarna payment method is not supported in the merchant's country by returning an empty array instead of throwing an error
 * Fix - Fix payment processing for $0 subscription with recurring coupon