woocommerce_valid_order_statuses_for_cancel

The WooCommerce woocommerce valid order statuses for cancel hook.

Description

apply_filters( 'woocommerce_valid_order_statuses_for_cancel', (callback) $array, (unknown) $order ); 

Parameters (2)

0. $array (callback) => array( 'pending', 'failed' )
The array.
1. $order (unknown)
The order.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'woocommerce_valid_order_statuses_for_cancel', $array, $order ); 
  2.  
  3. if ( !empty( $array ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_valid_order_statuses_for_cancel callback 
  2. function filter_woocommerce_valid_order_statuses_for_cancel( $array, $order ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_valid_order_statuses_for_cancel', 'filter_woocommerce_valid_order_statuses_for_cancel', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_valid_order_statuses_for_cancel', 'filter_woocommerce_valid_order_statuses_for_cancel', 10, 2 ); 

Defined (3)

The filter is defined in the following location(s).

/templates/myaccount/orders.php  
  1. if ( ! in_array( $order->get_status(), apply_filters( 'woocommerce_valid_order_statuses_for_cancel', array( 'pending', 'failed' ), $order ) ) ) { 
/templates/myaccount/my-orders.php  
  1. if ( ! in_array( $order->get_status(), apply_filters( 'woocommerce_valid_order_statuses_for_cancel', array( 'pending', 'failed' ), $order ) ) ) { 
/includes/class-wc-form-handler.php  
  1. $order_can_cancel = $order->has_status( apply_filters( 'woocommerce_valid_order_statuses_for_cancel', array( 'pending', 'failed' ) ) );