Create pending renewal order (improve safety/error handling)

changelog.txt

@@ -5,6 +5,7 @@
 * Fix - Safeguards added to the Subscriptions Totals template used in the My Account area, to guard against fatal errors that could arise in unusual conditions.
 * Fix - Correctly load product names with HTML on the cart and checkout shipping rates.
 * Fix - Improve our admin notice handling to ensure notices are displayed to the intended admin user.
+* Fix - Improve protections around the pending renewal order-creation process, to prevent uncaught exceptions and other errors from breaking the subscription editor.
 
 = 7.9.0 - 2025-01-10 =
 * Add - Compatibility with WooCommerce's new preview email feature introduced in 9.6.

includes/admin/class-wcs-admin-meta-boxes.php

@@ -247,21 +247,65 @@ public static function process_renewal_action_request( $subscription ) {
 	/**
 	 * Handles the action request to create a pending renewal order.
 	 *
-	 * @param array $subscription
-	 * @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
+	 * @param WC_Subscription $subscription
 	 */
 	public static function create_pending_renewal_action_request( $subscription ) {
 		$subscription->add_order_note( __( 'Create pending renewal order requested by admin action.', 'woocommerce-subscriptions' ), false, true );
-		$subscription->update_status( 'on-hold' );
+
+		try {
+			$subscription->update_status( 'on-hold' );
+		} catch ( Exception $e ) {
+			wcs_add_admin_notice(
+				__( 'Pending renewal order was not created, as it was not possible to update the subscription status.', 'woocommerce-subscriptions' ),
+				'error'
+			);
+			return;
+		}
 
 		$renewal_order = wcs_create_renewal_order( $subscription );
 
+		if ( is_wp_error( $renewal_order ) ) {
+			self::notify(
+				$subscription,
+				'error',
+				esc_html__( 'Creation of the pending renewal order failed.', 'woocommerce-subscriptions' )
+				. ' ' . $renewal_order->get_error_message()
+			);
+
+			return;
+		}
+
 		if ( ! $subscription->is_manual() ) {
+			$renewal_url = $renewal_order->get_edit_order_url();
+
+			try {
+				// We need to pass the payment gateway instance to be compatible with WC < 3.0, only WC 3.0+ supports passing the string name.
+				$renewal_order->set_payment_method( wc_get_payment_gateway_by_order( $subscription ) );
 
-			$renewal_order->set_payment_method( wc_get_payment_gateway_by_order( $subscription ) ); // We need to pass the payment gateway instance to be compatible with WC < 3.0, only WC 3.0+ supports passing the string name
+				if ( is_callable( array( $renewal_order, 'save' ) ) ) { // WC 3.0+
+					$renewal_order->save();
+				}
 
-			if ( is_callable( array( $renewal_order, 'save' ) ) ) { // WC 3.0+
-				$renewal_order->save();
+				wcs_add_admin_notice(
+					sprintf(
+						/* Translators: %1$s opening link tag, %2$s closing link tag. */
+						esc_html__( 'A pending %1$srenewal order%2$s was successfully created!', 'woocommerce-subscriptions' ),
+						'<a href="' . esc_url( $renewal_url ) . '">',
+						'</a>'
+					),
+					'success'
+				);
+			} catch ( WC_Data_Exception $e ) {
+				self::notify(
+					$subscription,
+					'error',
+					sprintf(
+						/* Translators: %1$s opening link tag, %2$s closing link tag. */
+						esc_html__( 'A %1$spending renewal order%2$s was successfully created, but there was a problem setting the payment method. Please review the order.', 'woocommerce-subscriptions' ),
+						'<a href="' . esc_url( $renewal_url ) . '">',
+						'</a>'
+					)
+				);
 			}
 		}
 	}
@@ -722,4 +766,22 @@ private static function reorder_subscription_line_items_meta_box() {
 			$items_meta_box['args']
 		);
 	}
+
+	/**
+	 * Notifies the user of an operational success or failure, and records a matching order note.
+	 *
+	 * In essence, it can be convenient to generate both an admin notice (to give the user some clear and
+	 * obvious feedback) and record the same as an order note (the admin notice could be missed, and is
+	 * auto-dismissed after the first view).
+	 *
+	 * @param WC_Subscription $subscription The subscription we are working with.
+	 * @param string          $type         Message type: 'success' or 'error.
+	 * @param string          $message      Message text, which will be used both for an admin notice and for the order note.
+	 *
+	 * @return void
+	 */
+	private static function notify( WC_Subscription $subscription, $type, $message ) {
+		$subscription->add_order_note( $message, false, true );
+		wcs_add_admin_notice( $message, $type );
+	}
 }

includes/admin/wcs-admin-functions.php

@@ -109,7 +109,7 @@ function wcs_display_admin_notices( $clear = true ) {
 				continue;
 			}
 
-			$notice_output[] = esc_html( $notice['message'] );
+			$notice_output[] = $notice['message'];
 			unset( $notices[ $index ] );
 		}
 

includes/wcs-renewal-functions.php

@@ -35,7 +35,17 @@ function wcs_create_renewal_order( $subscription ) {
 
 	WCS_Related_Order_Store::instance()->add_relation( $renewal_order, $subscription, 'renewal' );
 
-	return apply_filters( 'wcs_renewal_order_created', $renewal_order, $subscription );
+	/**
+	 * Provides an opportunity to monitor, interact with and replace renewal orders when they
+	 * are first created.
+	 *
+	 * @param WC_Order        $renewal_order The renewal order.
+	 * @param WC_Subscription $subscription  The subscription the renewal is related to.
+	 */
+	$filtered_renewal_order = apply_filters( 'wcs_renewal_order_created', $renewal_order, $subscription );
+
+	// It is possible that a filter function will replace the renewal order with something else entirely.
+	return $filtered_renewal_order instanceof WC_Order ? $filtered_renewal_order : $renewal_order;
 }
 
 /**

tests/unit/test-wcs-admin-functions.php

@@ -158,13 +158,13 @@ public function test_wcs_admin_notice_queue_clearance() {
 		wcs_add_admin_notice( $message_text, 'error' );
 
 		$this->assertStringContainsString(
-			esc_html( $message_text ),
+			$message_text,
 			$this->capture_wcs_admin_notice_text( false ),
 			'The admin notice is displayed as expected.'
 		);
 
 		$this->assertStringContainsString(
-			esc_html( $message_text ),
+			$message_text,
 			$this->capture_wcs_admin_notice_text(),
 			'The admin notice is displayed a second time, because it was not cleared last time.'
 		);