invited_user_email
Filters the contents of the email sent when an existing user is invited to join the site.
Usage
add_filter( 'invited_user_email', 'wp_kama_invited_user_email_filter', 10, 4 ); /** * Function for `invited_user_email` filter-hook. * * @param array $new_user_email Used to build wp_mail(). * @param int $user_id The invited user's ID. * @param array $role Array containing role information for the invited user. * @param string $newuser_key The key of the invitation. * * @return array */ function wp_kama_invited_user_email_filter( $new_user_email, $user_id, $role, $newuser_key ){ // filter... return $new_user_email; }
- $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.
Changelog
Since 5.6.0 | Introduced. |
Where the hook is called
In file: /wp-admin/user-new.php
invited_user_email
wp-admin/user-new.php 165
$new_user_email = apply_filters( 'invited_user_email', $new_user_email, $user_id, $role, $newuser_key );