Source View: get_{$adjacent}_post_join

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

  • Action hooks look like this: do_action( "hook_name" )
  • Filter hooks look like this: apply_filters( "hook_name", "what_to_filter" ).

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

Line Code
1687       * @since 2.5.0
1688       * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.
1689       *
1690       * @param string  $join           The JOIN clause in the SQL.
1691       * @param bool    $in_same_term   Whether post should be in a same taxonomy term.
1692       * @param array   $excluded_terms Array of excluded term IDs.
1693       * @param string  $taxonomy       Taxonomy. Used to identify the term used when `$in_same_term` is true.
1694       * @param WP_Post $post           WP_Post object.
1695       */
1696      $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms, $taxonomy, $post );
1697
1698      /**
1699       * Filters the WHERE clause in the SQL for an adjacent post query.
1700       *
1701       * The dynamic portion of the hook name, `$adjacent`, refers to the type
1702       * of adjacency, 'next' or 'previous'.
1703       *
1704       * @since 2.5.0
1705       * @since 4.4.0 Added the `$taxonomy` and `$post` parameters.