wc_ps_results_vars

The WooCommerce Predictive Search LITE wc ps results vars hook.

Description

apply_filters( 'wc_ps_results_vars', (callback) $array ); 

Parameters (1)

0. $array — Optional. (callback) => array( 'default_navigate' => $default_navigate, 'search_in' => $ps_current_search_in, 'ps_lang' => $current_lang, 'legacy_api_url' => $legacy_api_url, 'search_page_path' => $search_page_path, 'permalink_structure' => get_option('permalink_structure' ) )
The array.

Usage

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

Defined (1)

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

/classes/class-wc-predictive-search-backbone.php  
  1. wp_localize_script( 'wc-predictive-search-results-backbone', 'wc_ps_results_vars', apply_filters( 'wc_ps_results_vars', array( 'default_navigate' => $default_navigate, 'search_in' => $ps_current_search_in, 'ps_lang' => $current_lang, 'legacy_api_url' => $legacy_api_url, 'search_page_path' => $search_page_path, 'permalink_structure' => get_option('permalink_structure' ) ) ) );