How to use get_page_of_comment filter in WordPress

get_page_of_comment filter

Filters the calculated page on which a comment appears.

To use get_page_of_comment 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_get_page_of_comment_defaults which takes 4 parameters and we registered using add_filter. The first parameter get_page_of_comment is the name of the hook, the second parameter weplugins_modify_get_page_of_comment_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 may need to remove a registered hook, so you can use remove_filter to remove get_page_of_comment filter.

Parameters

Below are the 4 parameters required to use this hook.

• $page : (int) Comment page.
• $args : (array) Arguments used to calculate pagination. These include arguments auto-detected by the function, based on query vars, system settings, etc.
• $original_args : (array) Array of arguments passed to the function. Some or all of these may not be set.
• $comment_ID : (int) ID of the comment.

Live Example 1: Basic Usage

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

    function weplugins_modify_get_page_of_comment_defaults($page, $args, $original_args, $comment_ID) {
        // Update the $page variable according to your website requirements and return this variable.
        return $page;
    }
    // add the filter
    add_filter("get_page_of_comment", "weplugins_modify_get_page_of_comment_defaults", 10, 4);
    

Live Example 2: Conditional Modification

Here’s how you can modify the $page variable conditionally.

    function weplugins_modify_get_page_of_comment_defaults($page, $args, $original_args, $comment_ID) {
        if ($comment_ID % 2 == 0) {
            $page = 1; // Set page to 1 for even comment IDs
        }
        return $page;
    }
    add_filter("get_page_of_comment", "weplugins_modify_get_page_of_comment_defaults", 10, 4);
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("get_page_of_comment", "weplugins_modify_get_page_of_comment_defaults", 10, 4);
    

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

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