How to use get_page_uri filter in WordPress

get_page_uri filter

Filters the URI for a page.

To use the get_page_uri filter, first you have to register it using add_filter. You can write this code into the functions.php file 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 examples below, we define a function weplugins_modify_get_page_uri_defaults which takes 2 parameters, and we register it using add_filter. The first parameter get_page_uri is the name of the hook, the second parameter weplugins_modify_get_page_uri_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 get_page_uri filter.

Parameters

Below are the 2 parameters required to use this hook.

• $uri: (string) Page URI.
• $page: (WP_Post) Page object.

Live Example 1: Basic Usage

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

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

Live Example 2: Conditional URI Modification

Here’s an example of conditionally modifying the page URI.

    function weplugins_modify_get_page_uri_conditionally($uri, $page) {
        if ($page->ID == 42) {
            $uri = "custom-page-uri";
        }
        return $uri;
    }
    // add the filter
    add_filter("get_page_uri", "weplugins_modify_get_page_uri_conditionally", 10, 2);
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("get_page_uri", "weplugins_modify_get_page_uri_defaults", 10, 2);
    

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