How to use newuser_notify_siteadmin filter in WordPress

newuser_notify_siteadmin filter

Filters the message body of the new user activation email sent to the network administrator.

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

Parameters

Below are the 2 parameters required to use this hook.

• $msg : (string) Email body.
• $user : (WP_User) WP_User instance of the new user.

Live Example 1

Basic usage of the newuser_notify_siteadmin filter.

    function weplugins_modify_newuser_notify_siteadmin_defaults($msg, $user) {

        // Update the $msg variable according to your website requirements and return this variable. You can modify the $msg variable conditionally too if you want.

        return $msg; 
    }
    // add the filter
    add_filter( "newuser_notify_siteadmin", "weplugins_modify_newuser_notify_siteadmin_defaults", 10, 2 );
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter( "newuser_notify_siteadmin", "weplugins_modify_newuser_notify_siteadmin_defaults", 10, 2 );
    

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

Live Example 3

Modifying the email message conditionally based on user role.

    function weplugins_modify_newuser_notify_siteadmin_role_based($msg, $user) {
        if ( in_array( 'administrator', $user->roles ) ) {
            $msg = "An admin user has registered on your site.";
        } else {
            $msg = "A new user has registered on your site.";
        }
        return $msg;
    }
    add_filter( "newuser_notify_siteadmin", "weplugins_modify_newuser_notify_siteadmin_role_based", 10, 2 );
    

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.