Warning: This method has been deprecated. Moved to event handler instead.

WC_Abstract_Legacy_Order::cancel_order( string $note = '' )

Cancel the order and restore the cart (before payment).

Contents

Description Description

Parameters Parameters

$note

(Optional) (default: '') Optional note to add.

Default value: ''

Top ↑

Source Source

File: includes/legacy/abstract-wc-legacy-order.php

683
684
685
686
687
public function cancel_order( $note = '' ) {
    wc_deprecated_function( 'WC_Order::cancel_order', '3.0', 'WC_Order::update_status' );
    WC()->session->set( 'order_awaiting_payment', false );
    $this->update_status( 'cancelled', $note );
}

Expand full source code Collapse full source code

Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
woocommerce.php: WC()

Returns the main instance of WC.
includes/wc-deprecated-functions.php: wc_deprecated_function()

Wrapper for deprecated functions so we can apply some extra logic.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.