Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use get_adjacent_post_where filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 9, 2023
5 minutes read

 

get_adjacent_post_where filter
The dynamic portion of the hook name, $adjacent, refers to the type of adjacency, ‘next’ or ‘previous’. To use get_adjacent_post_where filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.
WePlugins always prefers to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.In the below live example, we have defined a function modify_get_adjacent_post_where_defaults which takes 5 parameters and we registered it using add_filter. The first parameter get_adjacent_post_where is the name of the hook, the second parameter modify_get_adjacent_post_where_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_filter to remove get_adjacent_post_where filter.

Parameters

Below are the 5 parameters required to use this hook.

  • $where: (string) The WHERE clause in the SQL.
  • $in_same_term: (bool) Whether the post should be in the 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.

Example 1: Basic Usage

This example shows how you can use the get_adjacent_post_where filter in its basic form.

        function weplugins_modify_get_adjacent_post_where_defaults($where, $in_same_term, $excluded_terms, $taxonomy, $post) {
            // Update the $where variable according to your website requirements and return this variable.
            return $where; 
        }
        // add the filter
        add_filter( "get_adjacent_post_where", "weplugins_modify_get_adjacent_post_where_defaults", 10, 5 );
        

Example 2: Removing a Hook

To remove a hook callback, use the example below.

        remove_filter( "get_adjacent_post_where", "weplugins_modify_get_adjacent_post_where_defaults", 10, 5 );
        

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Example 3: Conditional Modifications

This example demonstrates how to modify the $where variable conditionally based on your requirements.

        function weplugins_modify_get_adjacent_post_where_conditionally($where, $in_same_term, $excluded_terms, $taxonomy, $post) {
            if ($taxonomy == 'category') {
                // Modify $where when taxonomy is 'category'
            }
            return $where;
        }
        add_filter( "get_adjacent_post_where", "weplugins_modify_get_adjacent_post_where_conditionally", 10, 5 );
        

Access Premium WordPress Plugins

Contact Us

If you’re having any trouble using this hook or need customization, please Contact Us, and we’d be happy to assist you.

Sandeep Kumar Mishra

Sandeep Kumar Mishra

Sandeep Kumar Mishra writes about WordPress and Artificial Intelligence, offering tips and guides to help you master your website and stay updated with the latest tech trends.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.