How to use redirect_post_location filter in WordPress

redirect_post_location filter

Filters the post redirect destination URL.

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

Parameters

Below are the 2 parameters required to use this hook.

• $location : (string) The destination URL.
• $post_id : (int) The post ID.

Live Example

apply_filters( 'redirect_post_location', string $location, int $post_id )

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

Example 1: Modify Redirect Location

This example demonstrates how to modify the redirect location after a post is saved.

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

Example 2: Conditional Redirect

In this example, the redirect location is modified only if the post ID matches a specific value.

function weplugins_modify_redirect_post_location_conditional($location, $post_id) {
    if ($post_id == 123) {
        $location = home_url('/custom-page/');
    }
    return $location;
}
// add the filter
add_filter( "redirect_post_location", "weplugins_modify_redirect_post_location_conditional", 10, 2 );

Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

remove_filter( "redirect_post_location", "weplugins_modify_redirect_post_location_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’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.