Merge branch 'trunk' into fix/4678-query-args

Author: Matt Allan

changelog.txt

@@ -1,15 +1,24 @@
 *** WooCommerce Subscriptions Core Changelog ***
 
-= 8.1.0 - 2025-xx-xx =
+= 8.2.0 - 2025-xx-xx =
+* Update - Increase the number of args accepted by wcs_get_subscriptions(), to bring about parity with wc_get_orders().
+
+= 8.1.0 - 2025-03-24 =
 * Update - Improved subscription search performance for WP Post stores by removing unnecessary _order_key and _billing_email meta queries.
 * Update - Make it possible to dispatch the Cancelled Subscription email more than once (when initially set to pending-cancellation, and again when it reaches final cancellation).
 * Update - Reduced duplicate queries when fetching multiple subscription related orders types.
 * Update - Removed unnecessary get_time() calls to reduce redundant get_last_order() queries in the Subscriptions list table.
 * Update - Improved performance on the Orders list table when rendering the Subscription Relationship column.
-* Update - Increase the number of args accepted by wcs_get_subscriptions(), to bring about parity with wc_get_orders().
+* Update - Improved performance of the Generate Related Order Cache tool found under WooCommerce > Status > Tools.
+* Fix - Added support for previewing payment retry emails in WooCommerce email settings.
 * Fix - Updated subscription email item table template to align with WooCommerce 9.7 email improvements.
 * Fix - Prevent PHP warning on cart page shipping method updates by removing unused method: maybe_restore_shipping_methods.
+* Fix - Removed unnecessary setting of renewal order paid date on status transition, relying on WooCommerce core behavior instead.
 * Fix - Ensure the order_awaiting_payment session arg is restored when loading a renewal cart from the session to prevent duplicate orders.
+* Fix - Ensure custom placeholders (time_until_renewal, customers_first_name) are included in customer notification email previews.
+* Fix - For stores with HPOS + compatibility mode enabled, using the bulk delete related orders cache tool was not correctly deleting the meta from the WP Posts table.
+* Fix - Prevent empty strings being saved in related orders cache ID meta when backfilling order data to the WP Posts table.
+* Fix - Correctly load product names with HTML on the cart and checkout shipping rates.
 * Dev - Fix Node version mismatch between package.json and .nvmrc (both are now set to v16.17.1).
 
 = 8.0.1 - 2025-02-13 =

includes/class-wc-subscriptions-core-plugin.php

@@ -16,7 +16,7 @@ class WC_Subscriptions_Core_Plugin {
 	 * The version of subscriptions-core library.
 	 * @var string
 	 */
-	protected $library_version = '8.0.1'; // WRCS: DEFINED_VERSION.
+	protected $library_version = '8.1.0'; // WRCS: DEFINED_VERSION.
 
 	/**
 	 * The subscription scheduler instance.

includes/class-wc-subscriptions-renewal-order.php

@@ -96,27 +96,9 @@ public static function maybe_record_subscription_payment( $order_id, $orders_old
 		$order_needed_payment = in_array( $orders_old_status, apply_filters( 'woocommerce_valid_order_statuses_for_payment', array( 'pending', 'on-hold', 'failed' ), $order ) );
 
 		if ( $order_completed && $order_needed_payment ) {
-
-			if ( wcs_is_woocommerce_pre( '3.0' ) ) {
-				$update_post_data  = array(
-					'ID'            => $order_id,
-					'post_date'     => current_time( 'mysql', 0 ),
-					'post_date_gmt' => current_time( 'mysql', 1 ),
-				);
-
-				wp_update_post( $update_post_data );
-				update_post_meta( $order_id, '_paid_date', current_time( 'mysql' ) );
-			} else {
-
-				$current_time = current_time( 'timestamp', 1 );
-
-				// Prior to WC 3.0, we need to update the post date (i.e. the date created) to have a reliable representation of the paid date (both because it was in GMT and because it was always set). That's not needed in WC 3.0, but some plugins and store owners still rely on it being updated, so we want to make it possible to update it with 3.0 also.
-				if ( apply_filters( 'wcs_renewal_order_payment_update_date_created', false, $order, $subscriptions ) ) {
-					$order->set_date_created( $current_time );
-				}
-
-				// In WC 3.0, only the paid date prop represents the paid date, the post date isn't used anymore, also the paid date is stored and referenced as a MySQL date string in site timezone and a GMT timestamp
-				$order->set_date_paid( $current_time );
+			// Prior to WC 3.0, we need to update the post date (i.e. the date created) to have a reliable representation of the paid date (both because it was in GMT and because it was always set). That's not needed in WC 3.0, but some plugins and store owners still rely on it being updated, so we want to make it possible to update it with 3.0 also.
+			if ( apply_filters( 'wcs_renewal_order_payment_update_date_created', false, $order, $subscriptions ) ) {
+				$order->set_date_created( time() );
 				$order->save();
 			}
 		}

includes/class-wcs-cart-renewal.php

@@ -257,14 +257,20 @@ protected function set_order_awaiting_payment( $order_id ) {
 		if ( is_a( $order_id, 'WC_Abstract_Order' ) ) {
 			$order    = $order_id;
 			$order_id = $order->get_id();
+		} elseif ( ! empty( $order_id ) ) {
+			$order = wc_get_order( $order_id );
+		}
+
+		// Only ever set the order awaiting payment to 0 or an Order ID - not a subscription.
+		if ( $order && ! wcs_is_order( $order ) ) {
+			return;
 		}
 
 		WC()->session->set( 'order_awaiting_payment', $order_id );
 		WC()->session->set( 'store_api_draft_order', $order_id );
 
 		if ( $order_id ) {
-			// To avoid needing to load the order object, pass it if available, otherwise pass the order ID.
-			$this->set_cart_hash( $order ?? $order_id );
+			$this->set_cart_hash( $order );
 		}
 	}
 
@@ -1687,7 +1693,7 @@ public function restore_order_awaiting_payment( $cart ) {
 			}
 
 			// If the current user has permission to pay for the order, restore the order awaiting payment session arg.
-			if ( $this->validate_current_user( $order ) ) {
+			if ( wcs_is_order( $order ) && $this->validate_current_user( $order ) ) {
 				$this->set_order_awaiting_payment( $order );
 			}
 

includes/data-stores/class-wcs-orders-table-subscription-data-store.php

@@ -872,6 +872,11 @@ public function delete_all_metadata_by_key( $meta_key ) {
 		global $wpdb;
 
 		$wpdb->delete( self::get_meta_table_name(), [ 'meta_key' => $meta_key ], [ '%s' ] ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
+
+		// If custom order tables is enabled and data syncing is enabled, delete the meta from the custom order tables.
+		if ( wcs_is_custom_order_tables_usage_enabled() && wcs_is_custom_order_tables_data_sync_enabled() ) {
+			$this->get_cpt_data_store_instance()->delete_all_metadata_by_key( $meta_key );
+		}
 	}
 
 	/**

includes/data-stores/class-wcs-related-order-store-cached-cpt.php

@@ -306,7 +306,7 @@ protected function update_related_order_id_cache( $subscription, array $related_
 			}
 		}
 
-		$subscription_data_store = WC_Data_Store::load( 'subscription' );
+		$subscription_data_store = $subscription->get_data_store();
 		$current_metadata        = $this->get_related_order_metadata( $subscription, $relation_type );
 		$new_metadata            = array(
 			'key'   => $this->get_cache_meta_key( $relation_type ),
@@ -318,16 +318,24 @@ protected function update_related_order_id_cache( $subscription, array $related_
 			$this->update_modified_date_for_related_order_cache( $subscription, $related_order_ids, $current_metadata );
 		}
 
-		// Check if HPOS and data syncing is enabled then manually backfill the related orders cache values to WP Posts table.
-		$this->maybe_backfill_related_order_cache( $subscription, $relation_type, $new_metadata );
-
 		// If there is metadata for this key, update it, otherwise add it.
 		if ( $current_metadata ) {
 			$new_metadata['id'] = $current_metadata->meta_id;
-			return $subscription_data_store->update_meta( $subscription, (object) $new_metadata );
+			$return             = $subscription_data_store->update_meta( $subscription, (object) $new_metadata );
 		} else {
-			return $subscription_data_store->add_meta( $subscription, (object) $new_metadata );
+			$return = $subscription_data_store->add_meta( $subscription, (object) $new_metadata );
 		}
+
+		/**
+		 * Trigger update actions after modifying the subscription's related order cache metadata.
+		 *
+		 * This ensures that functions fired after a subscription update, such as webhooks and those in the DataSynchronizer,
+		 * which sync CPT post data to HPOS tables, are executed.
+		 */
+		do_action( 'woocommerce_update_order', $subscription->get_id(), $subscription );
+		do_action( 'woocommerce_update_subscription', $subscription->get_id(), $subscription );
+
+		return $return;
 	}
 
 	/**
@@ -344,8 +352,12 @@ protected function update_related_order_id_cache( $subscription, array $related_
 	 * @param WC_Subscription $subscription  The subscription object to backfill.
 	 * @param string          $relation_type The related order relationship type. Can be 'renewal', 'switch' or 'resubscribe'.
 	 * @param array           $metadata      The metadata to set update/add in the CPT data store. Should be an array with 'key' and 'value' keys.
+	 *
+	 * @deprecated 7.3.0 - Backfilling is already handled by the Order/Subscriptions Data Store.
 	 */
 	protected function maybe_backfill_related_order_cache( $subscription, $relation_type, $metadata ) {
+		wcs_deprecated_function( __METHOD__, '7.3.0' );
+
 		if ( ! wcs_is_custom_order_tables_usage_enabled() || ! wcs_is_custom_order_tables_data_sync_enabled() || empty( $metadata['key'] ) ) {
 			return;
 		}
@@ -389,7 +401,7 @@ public function delete_caches_for_subscription( $subscription, $relation_type =
 				$metadata = $this->get_related_order_metadata( $subscription, $possible_relation_type );
 
 				if ( $metadata ) {
-					WC_Data_Store::load( 'subscription' )->delete_meta( $subscription, (object) [ 'id' => $metadata->meta_id ] );
+					$subscription->get_data_store()->delete_meta( $subscription, (object) [ 'id' => $metadata->meta_id ] );
 				}
 			}
 		}
@@ -555,7 +567,7 @@ protected function get_subscription_ids_without_cache( $relation_types = array()
 			$ids   = wcs_get_orders_with_meta_query(
 				[
 					'limit'      => $limit,
-					'fields'     => 'ids',
+					'return'     => 'ids',
 					'orderby'    => 'ID',
 					'order'      => 'ASC',
 					'type'       => 'shop_subscription',
@@ -633,12 +645,11 @@ public function get_items_to_update() {
 	public function update_items_cache( $subscription_id ) {
 		$subscription = wcs_get_subscription( $subscription_id );
 
-		if ( $subscription ) {
-			foreach ( $this->get_relation_types() as $relation_type ) {
-				// Getting the related IDs also sets the cache when it's not already set
-				$this->get_related_order_ids( $subscription, $relation_type );
-			}
+		if ( ! $subscription ) {
+			return;
 		}
+
+		$this->get_related_order_ids_by_types( $subscription, $this->get_relation_types() );
 	}
 
 	/**
@@ -659,7 +670,7 @@ public function delete_all_caches() {
 	 */
 	protected function get_related_order_metadata( WC_Subscription $subscription, $relation_type, $data_store = null ) {
 		$cache_meta_key = $this->get_cache_meta_key( $relation_type );
-		$data_store     = empty( $data_store ) ? WC_Data_Store::load( 'subscription' ) : $data_store;
+		$data_store     = $data_store ?? $subscription->get_data_store();
 
 		foreach ( $this->get_subscription_meta( $subscription, $data_store ) as $meta ) {
 			if ( isset( $meta->meta_key ) && $cache_meta_key === $meta->meta_key ) {
@@ -704,11 +715,12 @@ protected function update_modified_date_for_related_order_cache( $subscription,
 	 */
 	private function get_subscription_meta( WC_Subscription $subscription, $data_store ) {
 		$subscription_id     = $subscription->get_id();
-		$is_batch_processing = isset( self::$batch_processing_related_orders[ $subscription_id ] );
+		$cache_key           = $this->get_batch_processing_cache_key( $subscription, $data_store );
+		$is_batch_processing = $this->is_batch_processing( $cache_key );
 
-		// If we are in batch processing mode, return the cached meta data.
-		if ( $is_batch_processing && isset( self::$subscription_meta_cache[ $subscription_id ] ) ) {
-			return self::$subscription_meta_cache[ $subscription_id ];
+		// If we are in batch processing mode, and there are cached results return the cached meta data.
+		if ( $is_batch_processing && isset( self::$subscription_meta_cache[ $cache_key ] ) ) {
+			return self::$subscription_meta_cache[ $cache_key ];
 		}
 
 		/**
@@ -724,9 +736,9 @@ private function get_subscription_meta( WC_Subscription $subscription, $data_sto
 		$subscription_meta            = $data_store->read_meta( $subscription );
 		self::$override_ignored_props = false;
 
-		// If we are in batch processing mode, cache the meta data.
+		// If we are in batch processing mode, cache the meta data so it can be returned for subsequent calls.
 		if ( $is_batch_processing ) {
-			self::$subscription_meta_cache[ $subscription_id ] = $subscription_meta;
+			self::$subscription_meta_cache[ $cache_key ] = $subscription_meta;
 		}
 
 		return $subscription_meta;
@@ -750,16 +762,66 @@ public function get_related_order_ids_by_types( WC_Order $subscription, $related
 		$related_order_ids = [];
 
 		// Declare batch processing mode for this subscription.
-		self::$batch_processing_related_orders[ $subscription_id ] = true;
+		$cache_key = $this->start_batch_processing_mode( $subscription );
 
 		foreach ( $related_order_types as $relation_type ) {
 			$related_order_ids[ $relation_type ] = $this->get_related_order_ids( $subscription, $relation_type );
 		}
 
-		// Unset the batch processing mode for this subscription.
-		unset( self::$batch_processing_related_orders[ $subscription_id ] );
-		unset( self::$subscription_meta_cache[ $subscription_id ] );
+		$this->stop_batch_processing_mode( $cache_key );
 
 		return $related_order_ids;
 	}
+
+	/**
+	 * Starts batch processing mode for a subscription.
+	 *
+	 * @param WC_Subscription $subscription The subscription to start batch processing mode for.
+	 * @return string The cache key for the subscription.
+	 */
+	private function start_batch_processing_mode( $subscription ) {
+		$cache_key = $this->get_batch_processing_cache_key( $subscription );
+
+		self::$batch_processing_related_orders[ $cache_key ] = true;
+		return $cache_key;
+	}
+
+	/**
+	 * Stops batch processing mode for a subscription.
+	 *
+	 * Destroys the cache and removes the cache key.
+	 *
+	 * @param string $cache_key The batch processing cache key.
+	 */
+	private function stop_batch_processing_mode( $cache_key ) {
+		unset( self::$batch_processing_related_orders[ $cache_key ] );
+		unset( self::$subscription_meta_cache[ $cache_key ] );
+	}
+
+	/**
+	 * Checks if batch processing mode is active for a subscription.
+	 *
+	 * @param string $cache_key The batch processing cache key.
+	 * @return bool True if batch processing mode is active, false otherwise.
+	 */
+	private function is_batch_processing( $cache_key ) {
+		return isset( self::$batch_processing_related_orders[ $cache_key ] );
+	}
+
+	/**
+	 * Gets the batch processing cache key for a subscription.
+	 *
+	 * The cache key is a unique combination of the subscription ID and the data store class name.
+	 *
+	 * @param WC_Subscription $subscription The subscription to get the cache key for.
+	 * @param bool|object     $data_store   The data store which will be used to read the subscription meta. Defaults to the current subscription's data store.
+	 *
+	 * @return string The cache key for the subscription.
+	 */
+	private function get_batch_processing_cache_key( $subscription, $data_store = null ) {
+		// If no data store is provided, use the subscription object's data store or load the default data store if no subscription data store is found.
+		$data_store       = $data_store ?? $subscription->get_data_store() ?? WC_Data_Store::load( 'subscriptions' );
+		$data_store_class = is_a( $data_store, 'WC_Data_Store' ) ? $data_store->get_current_class_name() : '';
+		return $data_store_class . '-' . $subscription->get_id();
+	}
 }

includes/data-stores/class-wcs-subscription-data-store-cpt.php

@@ -77,6 +77,13 @@ class WCS_Subscription_Data_Store_CPT extends WC_Order_Data_Store_CPT implements
 		'_subscription_switch_order_ids_cache'      => 'switch_order_ids_cache',
 	);
 
+	/**
+	 * The data store instance for the custom order tables.
+	 *
+	 * @var WCS_Orders_Table_Subscription_Data_Store
+	 */
+	protected $orders_table_data_store;
+
 	/**
 	 * Constructor.
 	 */
@@ -615,6 +622,11 @@ public function delete_all_metadata_by_key( $meta_key ) {
 		$meta_value = null; // Delete any values.
 		$delete_all = true;
 		delete_metadata( 'post', $id, $meta_key, $meta_value, $delete_all );
+
+		// If custom order tables is not enabled, but Data Syncing is enabled, delete the meta from the custom order tables.
+		if ( ! wcs_is_custom_order_tables_usage_enabled() && wcs_is_custom_order_tables_data_sync_enabled() ) {
+			$this->get_cot_data_store_instance()->delete_all_metadata_by_key( $meta_key );
+		}
 	}
 
 	/**
@@ -715,7 +727,10 @@ public function set_schedule_payment_retry( $subscription, $date ) {
 	 */
 	public function set_renewal_order_ids_cache( $subscription, $renewal_order_ids ) {
 		$this->cleanup_backfill_related_order_cache_duplicates( $subscription, 'renewal' );
-		update_post_meta( $subscription->get_id(), '_subscription_renewal_order_ids_cache', $renewal_order_ids );
+
+		if ( '' !== $renewal_order_ids ) {
+			update_post_meta( $subscription->get_id(), '_subscription_renewal_order_ids_cache', $renewal_order_ids );
+		}
 	}
 
 	/**
@@ -729,7 +744,10 @@ public function set_renewal_order_ids_cache( $subscription, $renewal_order_ids )
 	 */
 	public function set_resubscribe_order_ids_cache( $subscription, $resubscribe_order_ids ) {
 		$this->cleanup_backfill_related_order_cache_duplicates( $subscription, 'resubscribe' );
-		update_post_meta( $subscription->get_id(), '_subscription_resubscribe_order_ids_cache', $resubscribe_order_ids );
+
+		if ( '' !== $resubscribe_order_ids ) {
+			update_post_meta( $subscription->get_id(), '_subscription_resubscribe_order_ids_cache', $resubscribe_order_ids );
+		}
 	}
 
 	/**
@@ -743,7 +761,10 @@ public function set_resubscribe_order_ids_cache( $subscription, $resubscribe_ord
 	 */
 	public function set_switch_order_ids_cache( $subscription, $switch_order_ids ) {
 		$this->cleanup_backfill_related_order_cache_duplicates( $subscription, 'switch' );
-		update_post_meta( $subscription->get_id(), '_subscription_switch_order_ids_cache', $switch_order_ids );
+
+		if ( '' !== $switch_order_ids ) {
+			update_post_meta( $subscription->get_id(), '_subscription_switch_order_ids_cache', $switch_order_ids );
+		}
 	}
 
 	/**
@@ -767,4 +788,17 @@ private function cleanup_backfill_related_order_cache_duplicates( $subscription,
 			delete_post_meta( $subscription->get_id(), "_subscription_{$relationship_type}_order_ids_cache" );
 		}
 	}
+
+	/**
+	 * Get the data store instance for Order Tables data store.
+	 *
+	 * @return WCS_Orders_Table_Subscription_Data_Store
+	 */
+	public function get_cot_data_store_instance() {
+		if ( ! isset( $this->orders_table_data_store ) ) {
+			$this->orders_table_data_store = new WCS_Orders_Table_Subscription_Data_Store();
+		}
+
+		return $this->orders_table_data_store;
+	}
 }