woocommerce_formatted_refund_amount

Get formatted refunded amount.

Description

(string) apply_filters( 'woocommerce_formatted_refund_amount', (number) $wc_price, (unknown) $instance ); 

Returns (string)

Parameters (2)

0. $wc_price — Optional. (number) => wc_price( $this->get_amount(), array( 'currency' => $this->get_currency() ) )
The wc price.
1. $instance (unknown)
The instance.

Usage

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

Defined (1)

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

/includes/class-wc-order-refund.php  
  1. return apply_filters( 'woocommerce_formatted_refund_amount', wc_price( $this->get_amount(), array( 'currency' => $this->get_currency() ) ), $this );