WC_Abstract_Order::set_status │ public │ WC 3.0.0

Set order status.

Method of the class: WC_Abstract_Order{}

No Hooks.

Returns

Array. details of change

Usage

$WC_Abstract_Order = new WC_Abstract_Order();
$WC_Abstract_Order->set_status( $new_status );

$new_status(string) (required)

Status to change the order to. No internal wc- prefix is required.

Changelog

WC_Abstract_Order::set_status() WC Abstract Order::set status code ^{WC 10.4.3}

public function set_status( $new_status ) {
	$old_status = $this->get_status();
	$new_status = OrderUtil::remove_status_prefix( (string) $new_status );

	$status_exceptions = array( OrderStatus::AUTO_DRAFT, OrderStatus::TRASH );

	// If setting the status, ensure it's set to a valid status.
	if ( true === $this->object_read ) {
		// Only allow valid new status.
		if (
			! in_array( 'wc-' . $new_status, $this->get_valid_statuses(), true )
			&& ! in_array( $new_status, $status_exceptions, true )
		) {
			$new_status = OrderStatus::PENDING;
		}

		// If the old status is set but unknown (e.g. draft) assume its pending for action usage.
		if (
			$old_status
			&& (
				OrderStatus::AUTO_DRAFT === $old_status
				|| (
					! in_array( 'wc-' . $old_status, $this->get_valid_statuses(), true )
					&& ! in_array( $old_status, $status_exceptions, true )
				)
			)
		) {
			$old_status = OrderStatus::PENDING;
		}
	}

	$this->set_prop( 'status', $new_status );

	return array(
		'from' => $old_status,
		'to'   => $new_status,
	);
}