woocommerce_get_cancel_order_url_raw

Generates a raw (unescaped) cancel-order URL for use by payment gateways.

Description

(string) apply_filters( 'woocommerce_get_cancel_order_url_raw', (bool) $add_query_arg ); 

Returns (string)

The unescaped cancel-order URL.

Parameters (1)

0. $add_query_arg — Optional. (bool) => add_query_arg( array( 'cancel_order' => 'true', 'order' => $this->get_order_key(), 'order_id' => $this->get_id(), 'redirect' => $redirect, '_wpnonce' => wp_create_nonce( 'woocommerce-cancel_order' ), ), $this->get_cancel_endpoint() )
The add query arg.

Usage

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

Defined (1)

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

/includes/class-wc-order.php  
  1. return apply_filters( 'woocommerce_get_cancel_order_url_raw', add_query_arg( array(