How to use edit_post_link filter in WordPress

edit_post_link filter

Filters the post edit link anchor tag.

To use the edit_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_edit_post_link_defaults which takes 3 parameters and we registered using add_filter. The first parameter edit_post_link is the name of the hook, the second parameter modify_edit_post_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 the edit_post_link filter.

Parameters

Below are the 3 parameters required to use this hook.

• $link: (string) Anchor tag for the edit link.
• $post_id: (int) Post ID.
• $text: (string) Anchor text.

Live Example 1

This example demonstrates how you can modify the edit post link.

    function weplugins_modify_edit_post_link_defaults($link, $post_id, $text) { 
        // Update the $link variable according to your website requirements and return this variable. You can modify the $link variable conditionally too if you want.
        return $link; 
    }
    // Add the filter
    add_filter("edit_post_link", "weplugins_modify_edit_post_link_defaults", 10, 3);
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("edit_post_link", "weplugins_modify_edit_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

This example shows how you can use the hook to add custom classes to the edit post link anchor tag.

    function weplugins_add_custom_class_to_edit_post_link($link, $post_id, $text) {
        // Add custom class to the link
        $link = str_replace('<a ', '<a class="custom-class" ', $link);
        return $link;
    }
    // Add the filter
    add_filter("edit_post_link", "weplugins_add_custom_class_to_edit_post_link", 10, 3);
    

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.