invited_user_email WordPress Filter Hook
The WordPress hook 'invited_user_email' allows you to modify the email that is sent to a user when they are invited to join a site. This hook gives you the ability to customize the email message and subject, as well as the from address.
apply_filters( 'invited_user_email', array $new_user_email , int $user_id , array $role , string $newuser_key ) #
Filters the contents of the email sent when an existing user is invited to join the site.
Contents
Parameters
- $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.
- 'to'
- $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.
Source
File: wp-admin/user-new.php
Changelog
| Version | Description |
|---|---|
| 5.6.0 | Introduced. |