How to use get_comment_link filter in WordPress

get_comment_link filter

To use get_comment_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_comment_link_defaults which takes 4 parameters and we registered using add_filter. The first parameter get_comment_link is name of the hook, the second parameter modify_get_comment_link_defaults is name of the function which needs 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.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove get_comment_link filter.

Parameters

Below are the 4 parameters required to use this hook.

• $link: (string) The comment permalink with ‘#comment-$id’ appended.
• $comment: (WP_Comment) The current comment object.
• $args: (array) An array of arguments to override the defaults.
• $cpage: (int) The calculated ‘cpage’ value.

Live Example

Example 1: Basic Usage

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

    function weplugins_modify_get_comment_link_defaults($link, $comment, $args, $cpage) { 
        // 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("get_comment_link", "weplugins_modify_get_comment_link_defaults", 10, 4);
    

Example 2: Conditional Modification

In this example, we conditionally modify the comment link based on certain criteria.

    function weplugins_modify_get_comment_link_based_on_condition($link, $comment, $args, $cpage) { 
        if ($comment->comment_approved == '0') {
            $link .= '?pending=true';
        }
        return $link; 
    }
    add_filter("get_comment_link", "weplugins_modify_get_comment_link_based_on_condition", 10, 4);
    

Example 3: Removing the Filter

To remove a hook callback, use the example below.

    remove_filter("get_comment_link", "weplugins_modify_get_comment_link_defaults", 10, 4);
    

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