How to use invited_user_email filter in WordPress

invited_user_email filter

Filters the contents of the email sent when an existing user is invited to join the site.

To use invited_user_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 modify_invited_user_email_defaults which takes 4 parameters and we registered using add_filter. The first parameter invited_user_email is name of the hook, The second parameter modify_invited_user_email_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove invited_user_email filter.

Parameters

Below are the 4 parameters required to use this hook.

• $new_user_email : (array) Used to build wp_mail().
  • ‘to’ (string) The email address of the invited user.
  • ‘subject’ (string) The subject of the email.
  • ‘message’ (string) The content of the email.
  • ‘headers’ (string) Headers.
• $user_id : (int) The invited user’s ID.
• $role : (array) Array containing role information for the invited user.
• $newuser_key : (string) The key of the invitation.

Live Example

apply_filters( 'weplugins_invited_user_email', array $new_user_email, int $user_id, array $role, string $newuser_key )

Below is an example how you can use this hook.

Example 1: Modifying the Invitation Email

This example shows how you can modify the email content sent to the invited user.

    function weplugins_modify_invited_user_email_defaults($new_user_email, $user_id, $role, $newuser_key) { 
        // Update the $new_user_email variable according to your website requirements and return this variable.
        $new_user_email['subject'] = 'Welcome to Our Site!';
        $new_user_email['message'] = 'We are excited to have you join us!';
        return $new_user_email; 
    }
    // add the filter
    add_filter( "weplugins_invited_user_email", "weplugins_modify_invited_user_email_defaults", 10, 4 );
    

Example 2: Conditional Email Modifications

Here, the email content is modified based on user roles.

    function weplugins_modify_invited_user_email_based_on_role($new_user_email, $user_id, $role, $newuser_key) { 
        if (in_array('editor', $role)) {
            $new_user_email['subject'] = 'Welcome Editor!';
            $new_user_email['message'] = 'You have editor access!';
        }
        return $new_user_email; 
    }
    // add the filter
    add_filter( "weplugins_invited_user_email", "weplugins_modify_invited_user_email_based_on_role", 10, 4 );
    

Example 3: Removing the Filter

To remove a previously registered hook, use the example below.

    remove_filter( "weplugins_invited_user_email", "weplugins_modify_invited_user_email_defaults", 10, 4 );
    

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

Contact Us

If you need customization or have any trouble using this hook, please contact us and we’d be happy to assist you.