woocommerce_order_is_paid

Returns if an order has been paid for based on the order status.

Description

apply_filters( 'woocommerce_order_is_paid', (unknown) $this_has_status_wc_get_is_paid_statuses, (unknown) $instance ); 

Parameters (2)

0. $this_has_status_wc_get_is_paid_statuses (unknown)
The this has status wc get is paid statuses.
1. $instance (unknown)
The instance.

Usage

To run the hook, copy the example below.
  1. $this_has_status_wc_get_is_paid_statuses = apply_filters( 'woocommerce_order_is_paid', $this_has_status_wc_get_is_paid_statuses, $instance ); 
  2.  
  3. if ( !empty( $this_has_status_wc_get_is_paid_statuses ) ) { 
  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_is_paid callback 
  2. function filter_woocommerce_order_is_paid( $this_has_status_wc_get_is_paid_statuses, $instance ) { 
  3. // make filter magic happen here... 
  4. return $this_has_status_wc_get_is_paid_statuses
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_order_is_paid', 'filter_woocommerce_order_is_paid', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_order_is_paid', 'filter_woocommerce_order_is_paid', 10, 2 ); 

Defined (1)

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

/includes/class-wc-order.php  
  1. return apply_filters( 'woocommerce_order_is_paid', $this->has_status( wc_get_is_paid_statuses() ), $this );