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 Flipper Code, 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.


    Below are the 4 parameters are required to use this hook.

  • $new_user_email : (array) Used to build wp_mail().
    (string) The email address of the invited user.
    (string) The subject of the email.
    (string) The content of the email.
    (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( '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.

                        function 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. You can modify the $new_user_email variable conditionally too if you want.

                            return $new_user_email; 
                        // add the filter
                        add_filter( "invited_user_email", "modify_invited_user_email_defaults", 10, 4 );

To remove a hook callback, use the example below.

remove_filter( "invited_user_email", "modify_invited_user_email_defaults", 10, 4 );

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.


 Subscribe to our weekly newsletter below and never miss the latest updates in WordPress