woocommerce_product_related_posts_query

Return a list of related products (using data like categories and IDs).

Description

(array) apply_filters( 'woocommerce_product_related_posts_query', (unknown) $this_get_related_products_query_cats_array_tags_array_exclude_ids_limit_10, (unknown) $product_id ); 

Returns (array)

Parameters (2)

0. $this_get_related_products_query_cats_array_tags_array_exclude_ids_limit_10 (unknown)
The this get related products query cats array tags array exclude ids limit 10.
1. $product_id (unknown)
The product id.

Usage

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

Defined (1)

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

/includes/data-stores/class-wc-product-data-store-cpt.php  
  1. return $wpdb->get_col( implode( ' ', apply_filters( 'woocommerce_product_related_posts_query', $this->get_related_products_query( $cats_array, $tags_array, $exclude_ids, $limit + 10 ), $product_id ) ) );