woocommerce_order_has_status

Checks the order status against a passed in status.

Description

apply_filters( 'woocommerce_order_has_status', (bool) $var, (unknown) $instance, (unknown) $status ); 

Parameters (3)

0. $var — Optional. (bool) => ( is_array( $status ) && in_array( $this->get_status(), $status ) ) || $this->get_status() === $status ? true : false
The is array status in array this get status status this get status status true false.
1. $instance (unknown)
The instance.
2. $status (unknown)
The status.

Usage

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

Defined (1)

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

/includes/abstracts/abstract-wc-order.php  
  1. return apply_filters( 'woocommerce_order_has_status', ( is_array( $status ) && in_array( $this->get_status(), $status ) ) || $this->get_status() === $status ? true : false, $this, $status );