woocommerce_rest_private_query_vars

Filter the allowed 'private' query vars for authorized users.

Description

apply_filters( 'woocommerce_rest_private_query_vars', (array) $wp_private_query_vars ); 

If the user has the edit_posts capability, we also allow use of private query parameters, which are only undesirable on the frontend, but are safe for use in query strings.

To disable anyway, use 'add_filter( woocommerce_rest_private_query_vars,, __return_empty_array );'

Parameters (1)

0. $wp_private_query_vars (array)
Array of allowed query vars for authorized users. }

Usage

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

Defined (1)

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

/includes/abstracts/abstract-wc-rest-posts-controller.php  
  1. $private = apply_filters( 'woocommerce_rest_private_query_vars', $wp->private_query_vars );