How to use comment_notification_text filter in WordPress

comment_notification_text filter

Filters the comment notification email text.

To use the comment_notification_text 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_comment_notification_text_defaults which takes 2 parameters and we registered using add_filter. The first parameter comment_notification_text is the name of the hook, the second parameter weplugins_modify_comment_notification_text_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 comment_notification_text filter.

Parameters

Below are the 2 parameters required to use this hook.

• $notify_message : (string) The comment notification email text.
• $comment_id : (string) Comment ID as a numeric string.

Live Example

Example 1: Basic Usage

This example demonstrates how to modify the comment notification email text.

    function weplugins_modify_comment_notification_text_defaults($notify_message, $comment_id) { 
        // Update the $notify_message variable according to your website requirements
        $notify_message .= ' - Modified by WePlugins!';
        return $notify_message; 
    }
    // add the filter
    add_filter( "comment_notification_text", "weplugins_modify_comment_notification_text_defaults", 10, 2 );
    

Example 2: Conditional Modification

In this example, we modify the notification text conditionally based on the comment ID.

    function weplugins_modify_comment_notification_text_conditionally($notify_message, $comment_id) { 
        if ($comment_id == 1) {
            $notify_message .= ' - Special Comment!';
        }
        return $notify_message; 
    }
    // add the filter
    add_filter( "comment_notification_text", "weplugins_modify_comment_notification_text_conditionally", 10, 2 );
    

Example 3: Removing the Hook

This example shows how to remove a previously registered hook callback.

    // remove the filter
    remove_filter( "comment_notification_text", "weplugins_modify_comment_notification_text_defaults", 10, 2 );
    

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.