wpseo_posts_join

Filter JOIN query part for the post type.

Description

apply_filters( 'wpseo_posts_join', (bool) $false, (string) $post_type ); 

Parameters (2)

0. $false (bool) => false
SQL part, defaults to false.
1. $post_type (string)
Post type name.

Usage

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

Defined (1)

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

/inc/sitemaps/class-post-type-sitemap-provider.php  
  1. 'join' => apply_filters( 'wpseo_posts_join', false, $post_type ),