Merge branch 'trunk' into issue/791-only-set-paid-date-on-renewal-when-needed

Author: james-allan

assets/js/admin/admin-pointers.js

@@ -1,6 +1,15 @@
 jQuery( function ( $ ) {
+	let observer = null;
+
 	if ( arePointersEnabled() ) {
-		setTimeout( showSubscriptionPointers, 800 ); // give TinyMCE a chance to finish loading
+		observer = new MutationObserver( showSubscriptionPointers );
+	 
+	 	observer.observe( document.getElementById( 'poststuff' ), {
+			attributes: true,
+			childList: true,
+			characterData: false,
+			subtree:true,
+		} );
 	}
 
 	$( 'select#product-type' ).on( 'change', function () {
@@ -62,5 +71,9 @@ jQuery( function ( $ ) {
 			pointer: 'wcs_pointer',
 			action: 'dismiss-wp-pointer',
 		} );
+
+		if ( observer ) {
+			observer.disconnect();
+		}
 	}
 } );

changelog.txt

@@ -6,8 +6,13 @@
 * 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.
+* 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 - 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-email-notifications.php

@@ -53,9 +53,6 @@ public static function init() {
 		// Add settings UI.
 		add_filter( 'woocommerce_subscription_settings', [ __CLASS__, 'add_settings' ], 20 );
 
-		// Add admin notice.
-		add_action( 'admin_notices', [ __CLASS__, 'maybe_add_admin_notice' ] );
-
 		// Bump settings update time whenever related options change.
 		add_action( 'update_option_' . WC_Subscriptions_Admin::$option_prefix . self::$offset_setting_string, [ __CLASS__, 'set_notification_settings_update_time' ], 10, 3 );
 		add_action( 'update_option_' . WC_Subscriptions_Admin::$option_prefix . self::$switch_setting_string, [ __CLASS__, 'set_notification_settings_update_time' ], 10, 3 );
@@ -307,58 +304,4 @@ public static function add_settings( $settings ) {
 		WC_Subscriptions_Admin::insert_setting_after( $settings, WC_Subscriptions_Admin::$option_prefix . '_miscellaneous', $notification_settings, 'multiple_settings', 'sectionend' );
 		return $settings;
 	}
-
-	/**
-	 * Maybe add an admin notice to inform the store manager about the existance of the notifications feature.
-	 */
-	public static function maybe_add_admin_notice() {
-
-		// If the notifications feature is enabled, don't show the notice.
-		if ( self::notifications_globally_enabled() ) {
-			return;
-		}
-
-		// Prevent showing the notice on the Subscriptions settings page.
-		if ( isset( $_GET['page'], $_GET['tab'] ) && 'wc-settings' === $_GET['page'] && 'subscriptions' === $_GET['tab'] ) {
-			return;
-		}
-
-		$option_name = 'wcs_hide_customer_notifications_notice';
-		$nonce       = '_wcsnonce';
-		$action      = 'wcs_hide_customer_notifications_notice_action';
-
-		// First, check if the notice is being dismissed.
-		$nonce_argument = sanitize_text_field( wp_unslash( $_GET[ $nonce ] ?? '' ) );
-		if ( isset( $_GET[ $action ], $nonce_argument ) && wp_verify_nonce( $nonce_argument, $action ) ) {
-			update_option( $option_name, 'yes' );
-			wp_safe_redirect( remove_query_arg( [ $action, $nonce ] ) );
-			return;
-		}
-
-		if ( 'yes' === get_option( $option_name ) ) {
-			return;
-		}
-
-		$admin_notice   = new WCS_Admin_Notice( 'notice', array(), wp_nonce_url( add_query_arg( $action, 'dismiss' ), $action, $nonce ) );
-		$notice_title   = __( 'WooCommerce Subscriptions: Introducing customer email notifications!', 'woocommerce-subscriptions' );
-		$notice_content = __( 'You can now send email notifications for subscription renewals, expirations, and free trials. Go to the "Customer Notifications" settings section to configure when your customers receive these important updates.', 'woocommerce-subscriptions' );
-		$html_content   = sprintf( '<p class="main"><strong>%1$s</strong></p><p>%2$s</p>', $notice_title, $notice_content );
-		$admin_notice->set_html_content( $html_content );
-		$admin_notice->set_actions(
-			array(
-				array(
-					'name'  => __( 'Manage settings', 'woocommerce-subscriptions' ),
-					'url'   => admin_url( 'admin.php?page=wc-settings&tab=subscriptions' ),
-					'class' => 'button button-primary',
-				),
-				array(
-					'name'  => __( 'Learn more', 'woocommerce-subscriptions' ),
-					'url'   => 'https://woocommerce.com/document/subscriptions/subscriptions-notifications/',
-					'class' => 'button',
-				),
-			)
-		);
-
-		$admin_notice->display();
-	}
 }

includes/class-wc-subscriptions-email.php

@@ -241,25 +241,23 @@ public static function email_order_items_table( $order, $args = array() ) {
 			$order = wc_get_order( $order );
 		}
 
-		if ( is_a( $order, 'WC_Abstract_Order' ) ) {
-			$show_download_links_callback = ( isset( $args['show_download_links'] ) && $args['show_download_links'] ) ? '__return_true' : '__return_false';
-			$show_purchase_note_callback  = ( isset( $args['show_purchase_note'] ) && $args['show_purchase_note'] ) ? '__return_true' : '__return_false';
+		if ( ! is_a( $order, 'WC_Abstract_Order' ) ) {
+			return $items_table;
+		}
 
-			unset( $args['show_download_links'] );
-			unset( $args['show_purchase_note'] );
+		$show_download_links_callback = ( isset( $args['show_download_links'] ) && $args['show_download_links'] ) ? '__return_true' : '__return_false';
+		$show_purchase_note_callback  = ( isset( $args['show_purchase_note'] ) && $args['show_purchase_note'] ) ? '__return_true' : '__return_false';
 
-			add_filter( 'woocommerce_order_is_download_permitted', $show_download_links_callback );
-			add_filter( 'woocommerce_order_is_paid', $show_purchase_note_callback );
+		unset( $args['show_download_links'] );
+		unset( $args['show_purchase_note'] );
 
-			if ( function_exists( 'wc_get_email_order_items' ) ) { // WC 3.0+
-				$items_table = wc_get_email_order_items( $order, $args );
-			} else {
-				$items_table = $order->email_order_items_table( $args );
-			}
+		add_filter( 'woocommerce_order_is_download_permitted', $show_download_links_callback );
+		add_filter( 'woocommerce_order_is_paid', $show_purchase_note_callback );
 
-			remove_filter( 'woocommerce_order_is_download_permitted', $show_download_links_callback );
-			remove_filter( 'woocommerce_order_is_paid', $show_purchase_note_callback );
-		}
+		$items_table = wc_get_email_order_items( $order, $args );
+
+		remove_filter( 'woocommerce_order_is_download_permitted', $show_download_links_callback );
+		remove_filter( 'woocommerce_order_is_paid', $show_purchase_note_callback );
 
 		return $items_table;
 	}
@@ -274,13 +272,14 @@ public static function email_order_items_table( $order, $args = array() ) {
 	 * @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.1
 	 */
 	public static function order_details( $order, $sent_to_admin = false, $plain_text = false, $email = '' ) {
-
-		$order_items_table_args = array(
+		$email_improvements_enabled = wcs_is_wc_feature_enabled( 'email_improvements' );
+		$image_size                 = $email_improvements_enabled ? 48 : 32; // These image sizes are defaults for WC core emails. @see wc_get_email_order_items().
+		$order_items_table_args     = array(
 			'show_download_links' => ( $sent_to_admin ) ? false : $order->is_download_permitted(),
 			'show_sku'            => $sent_to_admin,
 			'show_purchase_note'  => ( $sent_to_admin ) ? false : $order->has_status( apply_filters( 'woocommerce_order_is_paid_statuses', array( 'processing', 'completed' ) ) ),
-			'show_image'          => '',
-			'image_size'          => '',
+			'show_image'          => $email_improvements_enabled,
+			'image_size'          => array( $image_size, $image_size ),
 			'plain_text'          => $plain_text,
 		);
 

includes/class-wcs-cart-renewal.php

@@ -113,6 +113,7 @@ public function setup_hooks() {
 		// Make sure renewal meta data persists between sessions
 		add_filter( 'woocommerce_get_cart_item_from_session', array( &$this, 'get_cart_item_from_session' ), 10, 3 );
 		add_action( 'woocommerce_cart_loaded_from_session', array( &$this, 'cart_items_loaded_from_session' ), 10 );
+		add_action( 'woocommerce_cart_loaded_from_session', array( $this, 'restore_order_awaiting_payment' ), 10 );
 
 		// Make sure fees are added to the cart
 		add_action( 'woocommerce_cart_calculate_fees', array( &$this, 'maybe_add_fees' ), 10, 1 );
@@ -248,14 +249,22 @@ public function maybe_setup_cart() {
 	 * @internal Core checkout uses order_awaiting_payment, Blocks checkout uses store_api_draft_order. Both validate the
 	 * cart hash to ensure the order matches the cart.
 	 *
-	 * @param int $order_id The order ID that is awaiting payment, or 0 to unset it.
+	 * @param int|WC_Order $order_id The order that is awaiting payment, or 0 to unset it.
 	 */
 	protected function set_order_awaiting_payment( $order_id ) {
+		$order = null;
+
+		if ( is_a( $order_id, 'WC_Abstract_Order' ) ) {
+			$order    = $order_id;
+			$order_id = $order->get_id();
+		}
+
 		WC()->session->set( 'order_awaiting_payment', $order_id );
 		WC()->session->set( 'store_api_draft_order', $order_id );
 
 		if ( $order_id ) {
-			$this->set_cart_hash( $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 );
 		}
 	}
 
@@ -1654,6 +1663,40 @@ public function set_renewal_order_cart_hash_on_block_checkout( $has_status, $ord
 		return $has_status;
 	}
 
+	/**
+	 * Restores the order awaiting payment session args if the cart contains a subscription-related order.
+	 *
+	 * It's possible the that order_awaiting_payment and store_api_draft_order session args are not set if those session args are lost due
+	 * to session destruction.
+	 *
+	 * This function checks the cart that is being loaded from the session and if the cart contains a subscription-related order and if the
+	 * current user has permission to pay for it. If so, it restores the order awaiting payment session args.
+	 *
+	 * @param WC_Cart $cart The cart object.
+	 */
+	public function restore_order_awaiting_payment( $cart ) {
+		if ( ! is_a( $cart, WC_Cart::class ) ) {
+			return;
+		}
+
+		foreach ( $cart->get_cart() as $cart_item ) {
+			$order = $this->get_order( $cart_item );
+
+			if ( ! $order ) {
+				continue;
+			}
+
+			// If the current user has permission to pay for the order, restore the order awaiting payment session arg.
+			if ( $this->validate_current_user( $order ) ) {
+				$this->set_order_awaiting_payment( $order );
+			}
+
+			// Once we found an order, exit even if the user doesn't have permission to pay for it.
+			return;
+
+		}
+	}
+
 	/* Deprecated */
 
 	/**

includes/emails/class-wc-subscriptions-email-preview.php

@@ -49,8 +49,14 @@ public function prepare_email_for_preview( $email ) {
 			case 'WCS_Email_Customer_Notification_Auto_Renewal':
 				$email->set_object( $this->get_dummy_subscription() );
 				break;
+			case 'WCS_Email_Customer_Payment_Retry':
+			case 'WCS_Email_Payment_Retry':
+				$email->retry = $this->get_dummy_retry( $email->object );
+				break;
 		}
 
+		$this->add_placeholders( $email );
+
 		add_filter( 'woocommerce_mail_content', [ $this, 'clean_up_filters' ] );
 
 		return $email;
@@ -139,13 +145,55 @@ private function get_dummy_address() {
 		return apply_filters( 'woocommerce_subscriptions_email_preview_dummy_address', $address, $this->email_type );
 	}
 
+	/**
+	 * Creates a dummy retry for use when previewing failed subscription payment retry emails.
+	 *
+	 * @param WC_Order $order The order object to create a dummy retry for.
+	 * @return WCS_Retry The dummy retry object.
+	 */
+	private function get_dummy_retry( $order ) {
+
+		if ( ! class_exists( 'WCS_Retry_Manager' ) ) {
+			return null;
+		}
+
+		$order_id   = is_a( $order, 'WC_Order' ) ? $order->get_id() : 12345;
+		$retry_rule = WCS_Retry_Manager::rules()->get_rule( 1, $order_id );
+
+		if ( is_a( $retry_rule, 'WCS_Retry_Rule' ) ) {
+			$interval       = $retry_rule->get_retry_interval();
+			$raw_retry_rule = $retry_rule->get_raw_data();
+		} else {
+			// If the retry rule is not found, use a default interval of 12 hours and an empty raw rule.
+			$interval       = 12 * HOUR_IN_SECONDS;
+			$raw_retry_rule = [];
+		}
+
+		return new WCS_Retry(
+			[
+				'status'   => 'pending',
+				'order_id' => $order_id,
+				'date_gmt' => gmdate( 'Y-m-d H:i:s', time() + $interval ),
+				'rule_raw' => $raw_retry_rule,
+			]
+		);
+	}
+
 	/**
 	 * Check if the email being previewed is a subscription email.
 	 *
-	 * @return bool
+	 * Subscription emails include:
+	 * - WC_Subscriptions_Email::$email_classes - core subscription emails.
+	 * - WC_Subscriptions_Email_Notifications::$email_classes - subscription notification emails (pre-renewal emails).
+	 * - WCS_Email_Customer_Payment_Retry - customer payment retry emails.
+	 * - WCS_Email_Payment_Retry - admin payment retry emails.
+	 *
+	 * @return bool Whether the email being previewed is a subscription email.
 	 */
 	private function is_subscription_email() {
-		return isset( WC_Subscriptions_Email::$email_classes[ $this->email_type ] ) || isset( WC_Subscriptions_Email_Notifications::$email_classes[ $this->email_type ] );
+		return isset( WC_Subscriptions_Email::$email_classes[ $this->email_type ] )
+			|| isset( WC_Subscriptions_Email_Notifications::$email_classes[ $this->email_type ] )
+			|| in_array( $this->email_type, [ 'WCS_Email_Customer_Payment_Retry', 'WCS_Email_Payment_Retry' ], true );
 	}
 
 	/**
@@ -204,4 +252,52 @@ public function allow_early_renewals_during_preview( $can_renew_early, $subscrip
 
 		return $can_renew_early;
 	}
+
+	/**
+	 * Adds custom placeholders for subscription emails.
+	 *
+	 * @param WC_Email $email The email object.
+	 */
+	private function add_placeholders( $email ) {
+		if ( ! isset( $email->placeholders ) ) {
+			return;
+		}
+
+		$placeholders = [];
+
+		switch ( $this->email_type ) {
+			case 'WCS_Email_Customer_Notification_Subscription_Expiration':
+			case 'WCS_Email_Customer_Notification_Manual_Trial_Expiration':
+			case 'WCS_Email_Customer_Notification_Auto_Trial_Expiration':
+			case 'WCS_Email_Customer_Notification_Manual_Renewal':
+			case 'WCS_Email_Customer_Notification_Auto_Renewal':
+				// Pull the real values from the email object (Order or Subscription) if available.
+				if ( is_a( $email->object, 'WC_Subscription' ) ) {
+					$time_until_renewal  = $email->get_time_until_date( $email->object, 'next_payment' );
+					$customer_first_name = $email->object->get_billing_first_name();
+				} else {
+					$time_until_renewal  = human_time_diff( time(), time() + WEEK_IN_SECONDS );
+					$customer_first_name = 'John';
+				}
+
+				$placeholders['{time_until_renewal}']   = $time_until_renewal;
+				$placeholders['{customers_first_name}'] = $customer_first_name;
+				break;
+			case 'WCS_Email_Customer_Payment_Retry':
+			case 'WCS_Email_Payment_Retry':
+				$retry_time = is_a( $email->retry, 'WCS_Retry' )
+					? $email->retry->get_time()
+					: time() + ( 12 * HOUR_IN_SECONDS );
+
+				$placeholders['{retry_time}'] = wcs_get_human_time_diff( $retry_time );
+				break;
+		}
+
+		// Merge placeholders without overriding existing ones, and only adding those in the email.
+		$email->placeholders = wp_parse_args(
+			$placeholders,
+			$email->placeholders
+		);
+	}
 }
+

includes/wcs-cart-functions.php

@@ -108,7 +108,7 @@ function wcs_cart_totals_shipping_html() {
 							<?php wcs_cart_print_shipping_input( $recurring_cart_package_key, $shipping_method ); ?>
 							<?php do_action( 'woocommerce_after_shipping_rate', $shipping_method, $recurring_cart_package_key ); ?>
 							<?php if ( ! empty( $show_package_details ) ) : ?>
-								<?php echo '<p class="woocommerce-shipping-contents"><small>' . esc_html( $package_details ) . '</small></p>'; ?>
+								<?php echo '<p class="woocommerce-shipping-contents"><small>' . wp_kses_post( $package_details ) . '</small></p>'; ?>
 							<?php endif; ?>
 							<?php if ( $recurring_rates_match_initial_rates ) : ?>
 								<?php wcs_cart_print_inherit_shipping_flag( $recurring_cart_package_key ); ?>

templates/cart/cart-recurring-shipping.php

@@ -35,7 +35,7 @@
 		<?php endif; ?>
 
 		<?php if ( $show_package_details ) : ?>
-			<?php echo '<p class="woocommerce-shipping-contents"><small>' . esc_html( $package_details ) . '</small></p>'; ?>
+			<?php echo '<p class="woocommerce-shipping-contents"><small>' . wp_kses_post( $package_details ) . '</small></p>'; ?>
 		<?php endif; ?>
 	</td>
 </tr>