How to use get_comment_author_link filter in WordPress

get_comment_author_link filter

Filters the comment author’s link for display.

To use get_comment_author_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_author_link_defaults which takes 3 parameters and we registered using add_filter. The first parameter get_comment_author_link is name of the hook, The second parameter modify_get_comment_author_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 get_comment_author_link filter.

Parameters

Below are the 3 parameters are required to use this hook.

• $return : (string) The HTML-formatted comment author link. Empty for an invalid URL.
• $author : (string) The comment author’s username.
• $comment_ID : (string) The comment ID as a numeric string.

Live Example 1: Linking to bbPress/BuddyPress Profile

To link to bbPress/BuddyPress profile or also link avatar, see this blog post.

    add_filter('get_comment_author_link', 'weplugins_se_link_comment_to_archives');
    function weplugins_se_link_comment_to_archives( $link ) {
        global $comment;
        if ( !empty( $comment->user_id ) && !empty( get_userdata( $comment->user_id )->ID ) ) {
            $link = sprintf('<a href="%s">%s</a>', get_author_posts_url($comment->user_id), get_comment_author());
        }
        return $link;
    }
    

Live Example 2: Modifying Comment Author Link

Below is an example how you can use this hook to modify the comment author link.

    function weplugins_modify_get_comment_author_link_defaults($return, $author, $comment_ID) { 
        // Update the $return variable according to your website requirements and return this variable. 
        // You can modify the $return variable conditionally too if you want.
        return $return; 
    }
    // add the filter
    add_filter( "get_comment_author_link", "weplugins_modify_get_comment_author_link_defaults", 10, 3 );
    

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "get_comment_author_link", "weplugins_modify_get_comment_author_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’re having any trouble using this hook or need customization, please Contact Us and we’d be happy to assist you.