How to use get_comment_author_email filter in WordPress

get_comment_author_email filter

Filters the comment author’s returned email address.

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

Parameters

Below are the 3 parameters required to use this hook:

• $comment_author_email: (string) The comment author’s email address.
• $comment_ID: (string) The comment ID as a numeric string.
• $comment: (WP_Comment) The comment object.

Live Examples

Basic Usage

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

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

Conditional Modification

This example demonstrates how to modify the email conditionally.

    function weplugins_modify_get_comment_author_email_defaults($comment_author_email, $comment_ID, $comment) { 
        if ($comment_ID % 2 == 0) {
            $comment_author_email = 'even@example.com';
        } else {
            $comment_author_email = 'odd@example.com';
        }
        return $comment_author_email; 
    }
    // add the filter
    add_filter("get_comment_author_email", "weplugins_modify_get_comment_author_email_defaults", 10, 3);
    

Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter("get_comment_author_email", "weplugins_modify_get_comment_author_email_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, please contact our WordPress Development Team and we’d be happy to assist you.