How to use get_pagenum_link filter in WordPress

get_pagenum_link filter

Filters the page number link for the current request.

To use get_pagenum_link 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_pagenum_link_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_pagenum_link is the name of the hook, The second parameter weplugins_modify_get_pagenum_link_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_pagenum_link filter.

Parameters

• $result : (string) The page number link.
• $pagenum : (int) The page number.

Live Example

apply_filters( 'get_pagenum_link', string $result, int $pagenum )

Example 1: Basic Usage

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

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

Example 2: Conditional Modification

Let’s say you want to modify the link only for a specific page number.

    function weplugins_modify_get_pagenum_link_conditionally($result, $pagenum) {
        if ($pagenum == 2) {
            $result = 'https://example.com/page/2/';
        }
        return $result;
    }
    add_filter( "get_pagenum_link", "weplugins_modify_get_pagenum_link_conditionally", 10, 2 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "get_pagenum_link", "weplugins_modify_get_pagenum_link_defaults", 10, 2 );
    

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