get_{$adjacent}_post_join WordPress Filter Hook

The get_{$adjacent}_post_join hook is called during SQL query for the next/previous post. This hook is giving developers the chance to alter the SQL JOIN clause used in the query, which can be useful for optimizing performance.

apply_filters( "get_{$adjacent}_post_join", string $join, bool $in_same_term, array $excluded_terms, string $taxonomy, WP_Post $post ) #

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


Description

The dynamic portion of the hook name, $adjacent, refers to the type of adjacency, ‘next’ or ‘previous’.

Possible hook names include:

  • get_next_post_join
  • get_previous_post_join

Top ↑

Parameters

$join

(string)The JOIN clause in the SQL.

$in_same_term

(bool)Whether post should be in a same taxonomy term.

$excluded_terms

(array)Array of excluded term IDs.

$taxonomy

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

$post

(WP_Post)WP_Post object.


Top ↑

Source

File: wp-includes/link-template.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.4.0Added the $taxonomy and $post parameters.
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More