How to use is_sticky filter in WordPress

is_sticky filter

Filters whether a post is sticky.

To use the is_sticky 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.

We at WePlugins always prefer 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 weplugins_modify_is_sticky_defaults which takes 2 parameters and we registered using add_filter. The first parameter is_sticky is the name of the hook, the second parameter weplugins_modify_is_sticky_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 the is_sticky filter.

Parameters

Below are the 2 parameters required to use this hook.

• $is_sticky: (bool) Whether a post is sticky.
• $post_id: (int) Post ID.

Live Example 1

Below is an example of how you can use this hook.

        function weplugins_modify_is_sticky_defaults($is_sticky, $post_id) { 
            // Update the $is_sticky variable according to your website requirements and return this variable. You can modify the $is_sticky variable conditionally too if you want.
            return $is_sticky; 
        }
        // add the filter
        add_filter("is_sticky", "weplugins_modify_is_sticky_defaults", 10, 2);
    

Live Example 2

Let’s say you want to make a specific post always sticky.

        function weplugins_always_sticky($is_sticky, $post_id) { 
            if ($post_id == 123) {
                return true;
            }
            return $is_sticky;
        }
        // add the filter
        add_filter("is_sticky", "weplugins_always_sticky", 10, 2);
    

Live Example 3

To remove a hook callback, use the example below.

        // remove the filter
        remove_filter("is_sticky", "weplugins_modify_is_sticky_defaults", 10, 2);
    

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

Contact Us

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