How to use comment_moderation_recipients filter in WordPress

comment_moderation_recipients filter

Filters the list of recipients for comment moderation emails.

To use the comment_moderation_recipients filter, you first 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 weplugins_modify_comment_moderation_recipients_defaults which takes 2 parameters and we registered using add_filter. The first parameter comment_moderation_recipients is the name of the hook, The second parameter weplugins_modify_comment_moderation_recipients_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_recipients filter.

Parameters

Below are the 2 parameters required to use this hook.

• $emails : (string[]) List of email addresses to notify for comment moderation.
• $comment_id : (int) Comment ID.

Live Example

apply_filters( 'comment_moderation_recipients', string[] $emails, int $comment_id )

Example 1: Basic Usage

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

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

Example 2: Removing a Hook Callback

To remove a hook callback, use the example below.

	remove_filter( "comment_moderation_recipients", "weplugins_modify_comment_moderation_recipients_defaults", 10, 2 );
	

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

Example 3: Adding Additional Email Recipients

This example demonstrates adding additional email recipients conditionally.

	function weplugins_modify_comment_moderation_recipients_additional($emails, $comment_id) { 
		// Add additional email addresses
		$emails[] = 'extra@example.com';
		return $emails; 
	}
	// add the filter
	add_filter( "comment_moderation_recipients", "weplugins_modify_comment_moderation_recipients_additional", 10, 2 );
	

Contact Us

If you’re having any trouble using this hook, please Contact Us and we’d be happy to assist you.