How to use comment_moderation_text filter in WordPress

comment_moderation_text filter

Filters the comment moderation email text.

To use the comment_moderation_text filter, first, you have to register it using add_filter. You can write this code into the 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_comment_moderation_text_defaults which takes 2 parameters and we registered it using add_filter. The first parameter comment_moderation_text is the name of the hook, the second parameter modify_comment_moderation_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_moderation_text filter.

Parameters

Below are the 2 parameters required to use this hook.

• $notify_message : (string) Text of the comment moderation email.
• $comment_id : (int) Comment ID.

Live Example

apply_filters('comment_moderation_text', string $notify_message, int $comment_id)

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

        function weplugins_modify_comment_moderation_text_defaults($notify_message, $comment_id) { 
            // Update the $notify_message variable according to your website requirements and return this variable. You can modify the $notify_message variable conditionally too if you want.
            return $notify_message; 
        }
        // add the filter
        add_filter("comment_moderation_text", "weplugins_modify_comment_moderation_text_defaults", 10, 2);
        

Example 1: Simple Modification

In this example, we modify the comment moderation text to add a custom message.

        function weplugins_custom_moderation_text($notify_message, $comment_id) {
            $notify_message .= "nnThank you for moderating comments on our site!";
            return $notify_message;
        }
        add_filter('comment_moderation_text', 'weplugins_custom_moderation_text', 10, 2);
        

Example 2: Conditional Modification

Here, we add a conditional check to customize the moderation message based on the comment ID.

        function weplugins_conditional_moderation_text($notify_message, $comment_id) {
            if ($comment_id == 123) {
                $notify_message .= "nnSpecial notice for comment ID 123.";
            }
            return $notify_message;
        }
        add_filter('comment_moderation_text', 'weplugins_conditional_moderation_text', 10, 2);
        

Example 3: Removing the Filter

To remove a hook callback, use the example below.

        remove_filter('comment_moderation_text', 'weplugins_modify_comment_moderation_text_defaults', 10, 2);
        

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