Including a new param to define whether to consider draft status when retrieving related orders

Author: wjrosa

includes/abstracts/abstract-wcs-related-order-store.php

@@ -86,10 +86,11 @@ protected function init() {}
 	 *
 	 * @param WC_Order $subscription The order or subscription for which calling code wants to find related orders.
 	 * @param string $relation_type The relationship between the subscription and the orders. Must be 'renewal', 'switch' or 'resubscribe' unless custom relationships are implemented.
+	 * @param bool $include_draft Whether to include draft orders in the results (`wc-checkout-draft` status).
 	 *
 	 * @return array
 	 */
-	abstract public function get_related_order_ids( WC_Order $subscription, $relation_type );
+	abstract public function get_related_order_ids( WC_Order $subscription, $relation_type, $include_draft = true );
 
 	/**
 	 * Find subscriptions related to a given order in a given way, if any.

includes/class-wc-subscription.php

@@ -2049,10 +2049,11 @@ public function get_related_orders( $return_fields = 'ids', $order_types = array
 	 * Get the related order IDs for a subscription based on an order type.
 	 *
 	 * @param string $order_type Can include 'any', 'parent', 'renewal', 'resubscribe' and/or 'switch'. Defaults to 'any'.
+	 * @param bool $include_draft Whether to include draft orders in the search. Defaults to true.
 	 * @return array List of related order IDs.
 	 * @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.3.0
 	 */
-	protected function get_related_order_ids( $order_type = 'any' ) {
+	protected function get_related_order_ids( $order_type = 'any', $include_draft = true ) {
 
 		$related_order_ids = array();
 
@@ -2065,7 +2066,7 @@ protected function get_related_order_ids( $order_type = 'any' ) {
 			$relation_types = ( 'any' === $order_type ) ? array( 'renewal', 'resubscribe', 'switch' ) : array( $order_type );
 
 			foreach ( $relation_types as $relation_type ) {
-				$related_order_ids = array_merge( $related_order_ids, WCS_Related_Order_Store::instance()->get_related_order_ids( $this, $relation_type ) );
+				$related_order_ids = array_merge( $related_order_ids, WCS_Related_Order_Store::instance()->get_related_order_ids( $this, $relation_type, $include_draft ) );
 			}
 		}
 
@@ -2077,9 +2078,10 @@ protected function get_related_order_ids( $order_type = 'any' ) {
 	 *
 	 * @param string $return_fields The columns to return, either 'all' or 'ids'
 	 * @param array $order_types Can include any combination of 'parent', 'renewal', 'switch' or 'any' which will return the latest renewal order of any type. Defaults to 'parent' and 'renewal'.
+	 * @param bool $include_draft Whether to include draft orders in the search. Defaults to true.
 	 * @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
 	 */
-	public function get_last_order( $return_fields = 'ids', $order_types = array( 'parent', 'renewal' ) ) {
+	public function get_last_order( $return_fields = 'ids', $order_types = array( 'parent', 'renewal' ), $include_draft = true ) {
 
 		$return_fields  = ( 'ids' == $return_fields ) ? $return_fields : 'all';
 		$order_types    = ( 'any' == $order_types ) ? array( 'parent', 'renewal', 'switch' ) : (array) $order_types;
@@ -2093,7 +2095,7 @@ public function get_last_order( $return_fields = 'ids', $order_types = array( 'p
 					}
 					break;
 				default:
-					$related_orders = array_merge( $related_orders, $this->get_related_order_ids( $order_type ) );
+					$related_orders = array_merge( $related_orders, $this->get_related_order_ids( $order_type, $include_draft ) );
 					break;
 			}
 		}

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

@@ -36,13 +36,15 @@ public function __construct() {
 	 *
 	 * @param WC_Order $subscription  The ID of the subscription for which calling code wants the related orders.
 	 * @param string   $relation_type The relationship between the subscription and the orders. Must be 'renewal', 'switch' or 'resubscribe.
+	 * @param bool     $include_draft Whether to include draft orders in the results (`wc-checkout-draft` status).
 	 *
 	 * @return array
 	 */
-	public function get_related_order_ids( WC_Order $subscription, $relation_type ) {
-		// Filter out the new 'wc-checkout-draft' status, as it is not a valid order status for our purposes.
-		$statuses = array_keys( wc_get_order_statuses() );
-		unset( $statuses[ array_search( 'wc-checkout-draft', $statuses, true ) ] );
+	public function get_related_order_ids( WC_Order $subscription, $relation_type, $include_draft = true ) {
+		if ( ! $include_draft ) {
+			$statuses = array_keys( wc_get_order_statuses() );
+			unset( $statuses[ array_search( 'wc-checkout-draft', $statuses, true ) ] );
+		}
 		return wcs_get_orders_with_meta_query(
 			[
 				'limit'      => -1,