jetpack_relatedposts_filter_exclude_post_ids

Filter the Post IDs excluded from appearing in Related Posts.

Description

apply_filters( 'jetpack_relatedposts_filter_exclude_post_ids', (array) $args_exclude_post_ids, (string) $post_id ); 

Parameters (2)

0. $args_exclude_post_ids (array)
The args exclude post ids.
1. $post_id (string)
Post ID of the post for which we are retrieving Related Posts.

Usage

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

Defined (1)

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

/modules/related-posts/jetpack-related-posts.php  
  1. $args['exclude_post_ids'] = apply_filters( 'jetpack_relatedposts_filter_exclude_post_ids', $args['exclude_post_ids'], $post_id );