get_previous_post_join │ filter-hook │ WP 2.5.0

Filters the JOIN clause in the SQL for an adjacent post query.

Usage

add_filter( 'get_previous_post_join', 'wp_kama_get_previous_post_join_filter', 10, 5 );

/**
 * Function for `get_previous_post_join` filter-hook.
 * 
 * @param string       $join           The JOIN clause in the SQL.
 * @param bool         $in_same_term   Whether post should be in the same taxonomy term.
 * @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided.
 * @param string       $taxonomy       Taxonomy. Used to identify the term used when `$in_same_term` is true.
 * @param WP_Post      $post           WP_Post object.
 *
 * @return string
 */
function wp_kama_get_previous_post_join_filter( $join, $in_same_term, $excluded_terms, $taxonomy, $post ){

	// filter...
	return $join;
}

$join(string)

The JOIN clause in the SQL.

$in_same_term(true|false)

Whether post should be in the same taxonomy term.

$excluded_terms(int[]|string)

Array of excluded term IDs. Empty string if none were provided.

$taxonomy(string)

Taxonomy. Used to identify the term used when $in_same_term is true.

$post(WP_Post)

WP_Post object.

Changelog

Where the hook is called

$join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms, $taxonomy, $post );

Where the hook is used in WordPress