How to use get_delete_post_link filter in WordPress

get_delete_post_link filter

Filters the post delete link.

To use the get_delete_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_get_delete_post_link_defaults which takes 3 parameters and we registered using add_filter. The first parameter get_delete_post_link is the name of the hook, the second parameter modify_get_delete_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 get_delete_post_link filter.

Parameters

Below are the 3 parameters required to use this hook.

• $link: (string) The delete link.
• $post_id: (int) Post ID.
• $force_delete: (bool) Whether to bypass the Trash and force deletion. Default false.

Live Example

apply_filters( 'get_delete_post_link', string $link, int $post_id, bool $force_delete )

Below is an example how you can use this hook.

Example 1: Basic Usage

This example shows how to modify the delete post link using the get_delete_post_link filter.

    function weplugins_modify_get_delete_post_link_defaults($link, $post_id, $force_delete) { 
        // Update the $link variable according to your website requirements and return this variable.
        return $link; 
    }
    // add the filter
    add_filter( 'get_delete_post_link', 'weplugins_modify_get_delete_post_link_defaults', 10, 3 );
    

Example 2: Conditional Modification

This example demonstrates how you can conditionally modify the delete post link based on certain criteria.

    function weplugins_modify_get_delete_post_link_conditionally($link, $post_id, $force_delete) { 
        if ($post_id == 123) {
            $link = str_replace('delete', 'remove', $link);
        }
        return $link; 
    }
    // add the filter
    add_filter( 'get_delete_post_link', 'weplugins_modify_get_delete_post_link_conditionally', 10, 3 );
    

Example 3: Removing the Filter

To remove a hook callback, use the example below.

    // remove the filter
    remove_filter( 'get_delete_post_link', 'weplugins_modify_get_delete_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.

Contact Us

If you need any customization or have any trouble using this hook, please contact our team and we’d be happy to assist you.