How to use page_link filter in WordPress

page_link filter

Filters the permalink for a page.

To use the page_link filter, first, you have to register it using add_filter. You can write this code into the 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_page_link_defaults which takes 3 parameters and we registered using add_filter. The first parameter page_link is the name of the hook, the second parameter weplugins_modify_page_link_defaults is the name of the function that 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 page_link filter.

Parameters

Below are the 3 parameters required to use this hook.

• $link: (string) The page’s permalink.
• $post_id: (int) The ID of the page.
• $sample: (bool) Is it a sample permalink.

Live Example 1: Modify Page Link

This example demonstrates how you can use the page_link filter to modify the page link as per your requirements.

    function weplugins_modify_page_link_defaults($link, $post_id, $sample) {
        // Update the $link variable according to your website requirements and return this variable.
        return $link;
    }
    // add the filter
    add_filter("page_link", "weplugins_modify_page_link_defaults", 10, 3);
    

Live Example 2: Conditional Link Modification

Here’s an example where the page link is modified conditionally based on certain criteria.

    function weplugins_modify_page_link_conditional($link, $post_id, $sample) {
        if ($sample) {
            $link = home_url('/sample-page/');
        }
        return $link;
    }
    add_filter("page_link", "weplugins_modify_page_link_conditional", 10, 3);
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("page_link", "weplugins_modify_page_link_defaults", 10, 3);
    

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 any customization or are facing issues with this hook, feel free to contact us. We’d be happy to assist you!