How to use pre_post_link filter in WordPress

pre_post_link filter

Only applies to posts with post_type of ‘post’.

To use pre_post_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 modify_pre_post_link_defaults which takes 3 parameters and we registered using add_filter. The first parameter pre_post_link is name of the hook, The second parameter modify_pre_post_link_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove pre_post_link filter.

Parameters

Below are the 3 parameters required to use this hook.

• $permalink: (string) The site’s permalink structure.
• $post: (WP_Post) The post in question.
• $leavename: (bool) Whether to keep the post name.

Live Example 1

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

    function weplugins_modify_pre_post_link_defaults($permalink, $post, $leavename) { 
        // Update the $permalink variable according to your website requirements and return this variable. You can modify the $permalink variable conditionally too if you want.
        return $permalink; 
    }
    // Add the filter
    add_filter("pre_post_link", "weplugins_modify_pre_post_link_defaults", 10, 3);
    

Live Example 2

To remove a hook callback, use the example below.

    // Remove the filter
    remove_filter("pre_post_link", "weplugins_modify_pre_post_link_defaults", 10, 3);
    

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

Live Example 3

Here is another example demonstrating conditional usage of the hook.

    function weplugins_modify_pre_post_link_conditionally($permalink, $post, $leavename) {
        if ($post->post_type == 'custom_post_type') {
            // Update permalink for custom post type
            $permalink = str_replace('%custom_taxonomy%', 'custom-value', $permalink);
        }
        return $permalink;
    }
    // Add the filter
    add_filter("pre_post_link", "weplugins_modify_pre_post_link_conditionally", 10, 3);
    

Contact Us

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