wp_new_user_notification( int $user_id, null $deprecated = null, string $notify =  )

Emails login credentials to a newly-registered user.

Description

A new user registration notification is also sent to admin email.

Parameters

$user_idintrequired
User ID.
$deprecatednulloptional
Not used (argument deprecated).

Default:null

$notifystringoptional
Type of notification that should happen. Accepts 'admin' or an empty string (admin only), 'user', or 'both' (admin and user).

Default:''

More Information

  • This function can be replaced via plugins. If plugins do not redefine these functions, then this will be used instead.

Source

function wp_new_user_notification( $user_id, $deprecated = null, $notify = '' ) {
	if ( null !== $deprecated ) {
		_deprecated_argument( __FUNCTION__, '4.3.1' );
	}

	// Accepts only 'user', 'admin' , 'both' or default '' as $notify.
	if ( ! in_array( $notify, array( 'user', 'admin', 'both', '' ), true ) ) {
		return;
	}

	$user = get_userdata( $user_id );

	/*
	 * The blogname option is escaped with esc_html() on the way into the database in sanitize_option().
	 * We want to reverse this for the plain text arena of emails.
	 */
	$blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );

	/**
	 * Filters whether the admin is notified of a new user registration.
	 *
	 * @since 6.1.0
	 *
	 * @param bool    $send Whether to send the email. Default true.
	 * @param WP_User $user User object for new user.
	 */
	$send_notification_to_admin = apply_filters( 'wp_send_new_user_notification_to_admin', true, $user );

	if ( 'user' !== $notify && true === $send_notification_to_admin ) {
		$switched_locale = switch_to_locale( get_locale() );

		/* translators: %s: Site title. */
		$message = sprintf( __( 'New user registration on your site %s:' ), $blogname ) . "\r\n\r\n";
		/* translators: %s: User login. */
		$message .= sprintf( __( 'Username: %s' ), $user->user_login ) . "\r\n\r\n";
		/* translators: %s: User email address. */
		$message .= sprintf( __( 'Email: %s' ), $user->user_email ) . "\r\n";

		$wp_new_user_notification_email_admin = array(
			'to'      => get_option( 'admin_email' ),
			/* translators: New user registration notification email subject. %s: Site title. */
			'subject' => __( '[%s] New User Registration' ),
			'message' => $message,
			'headers' => '',
		);

		/**
		 * Filters the contents of the new user notification email sent to the site admin.
		 *
		 * @since 4.9.0
		 *
		 * @param array   $wp_new_user_notification_email_admin {
		 *     Used to build wp_mail().
		 *
		 *     @type string $to      The intended recipient - site admin email address.
		 *     @type string $subject The subject of the email.
		 *     @type string $message The body of the email.
		 *     @type string $headers The headers of the email.
		 * }
		 * @param WP_User $user     User object for new user.
		 * @param string  $blogname The site title.
		 */
		$wp_new_user_notification_email_admin = apply_filters( 'wp_new_user_notification_email_admin', $wp_new_user_notification_email_admin, $user, $blogname );

		wp_mail(
			$wp_new_user_notification_email_admin['to'],
			wp_specialchars_decode( sprintf( $wp_new_user_notification_email_admin['subject'], $blogname ) ),
			$wp_new_user_notification_email_admin['message'],
			$wp_new_user_notification_email_admin['headers']
		);

		if ( $switched_locale ) {
			restore_previous_locale();
		}
	}

	/**
	 * Filters whether the user is notified of their new user registration.
	 *
	 * @since 6.1.0
	 *
	 * @param bool    $send Whether to send the email. Default true.
	 * @param WP_User $user User object for new user.
	 */
	$send_notification_to_user = apply_filters( 'wp_send_new_user_notification_to_user', true, $user );

	// `$deprecated` was pre-4.3 `$plaintext_pass`. An empty `$plaintext_pass` didn't sent a user notification.
	if ( 'admin' === $notify || true !== $send_notification_to_user || ( empty( $deprecated ) && empty( $notify ) ) ) {
		return;
	}

	$key = get_password_reset_key( $user );
	if ( is_wp_error( $key ) ) {
		return;
	}

	$switched_locale = switch_to_user_locale( $user_id );

	/* translators: %s: User login. */
	$message  = sprintf( __( 'Username: %s' ), $user->user_login ) . "\r\n\r\n";
	$message .= __( 'To set your password, visit the following address:' ) . "\r\n\r\n";
	$message .= network_site_url( "wp-login.php?action=rp&key=$key&login=" . rawurlencode( $user->user_login ), 'login' ) . "\r\n\r\n";

	$message .= wp_login_url() . "\r\n";

	$wp_new_user_notification_email = array(
		'to'      => $user->user_email,
		/* translators: Login details notification email subject. %s: Site title. */
		'subject' => __( '[%s] Login Details' ),
		'message' => $message,
		'headers' => '',
	);

	/**
	 * Filters the contents of the new user notification email sent to the new user.
	 *
	 * @since 4.9.0
	 *
	 * @param array   $wp_new_user_notification_email {
	 *     Used to build wp_mail().
	 *
	 *     @type string $to      The intended recipient - New user email address.
	 *     @type string $subject The subject of the email.
	 *     @type string $message The body of the email.
	 *     @type string $headers The headers of the email.
	 * }
	 * @param WP_User $user     User object for new user.
	 * @param string  $blogname The site title.
	 */
	$wp_new_user_notification_email = apply_filters( 'wp_new_user_notification_email', $wp_new_user_notification_email, $user, $blogname );

	wp_mail(
		$wp_new_user_notification_email['to'],
		wp_specialchars_decode( sprintf( $wp_new_user_notification_email['subject'], $blogname ) ),
		$wp_new_user_notification_email['message'],
		$wp_new_user_notification_email['headers']
	);

	if ( $switched_locale ) {
		restore_previous_locale();
	}
}

Hooks

apply_filters( ‘wp_new_user_notification_email’, array $wp_new_user_notification_email, WP_User $user, string $blogname )

Filters the contents of the new user notification email sent to the new user.

apply_filters( ‘wp_new_user_notification_email_admin’, array $wp_new_user_notification_email_admin, WP_User $user, string $blogname )

Filters the contents of the new user notification email sent to the site admin.

apply_filters( ‘wp_send_new_user_notification_to_admin’, bool $send, WP_User $user )

Filters whether the admin is notified of a new user registration.

apply_filters( ‘wp_send_new_user_notification_to_user’, bool $send, WP_User $user )

Filters whether the user is notified of their new user registration.

Changelog

VersionDescription
4.6.0The $notify parameter accepts 'user' for sending notification only to the user created.
4.3.1The $plaintext_pass parameter was deprecated. $notify added as a third parameter.
4.3.0The $plaintext_pass parameter was changed to $notify.
2.0.0Introduced.

User Contributed Notes

  1. Skip to note 5 content

    Now is pluggable, so you can add in your functions.php with a add_filter

    @since 4.9.0

    /**
     * Custom register email
     */
    add_filter( 'wp_new_user_notification_email', 'custom_wp_new_user_notification_email', 10, 3 );
    function custom_wp_new_user_notification_email( $wp_new_user_notification_email, $user, $blogname ) {
    
    	$user_login = stripslashes( $user->user_login );
    	$user_email = stripslashes( $user->user_email );
    	$login_url	= wp_login_url();
    	$message  = __( 'Hi there,' ) . "/r/n/r/n";
    	$message .= sprintf( __( "Welcome to %s! Here's how to log in:" ), get_option('blogname') ) . "/r/n/r/n";
    	$message .= wp_login_url() . "/r/n";
    	$message .= sprintf( __('Username: %s'), $user_login ) . "/r/n";
    	$message .= sprintf( __('Email: %s'), $user_email ) . "/r/n";
    	$message .= __( 'Password: The one you entered in the registration form. (For security reason, we save encripted password)' ) . "/r/n/r/n";
    	$message .= sprintf( __('If you have any problems, please contact me at %s.'), get_option('admin_email') ) . "/r/n/r/n";
    	$message .= __( 'bye!' );
    
    	$wp_new_user_notification_email['subject'] = sprintf( '[%s] Your credentials.', $blogname );
    	$wp_new_user_notification_email['headers'] = array('Content-Type: text/html; charset=UTF-8');
    	$wp_new_user_notification_email['message'] = $message;
    
    	return $wp_new_user_notification_email;
    }
  2. Skip to note 6 content

    After you insert new user with wp_insert_user(), you can call this wp_new_user_notification() function to send mail for newly registered users.
    However, In order to customise them, you need to define this function and save it as a plugin of its own. But, it still have a chance that some other plugin (that is called before this) have control over it. So, the best way of customising it is saving it as a mu-plugin. Just create a folder ‘mu-plugins’ under wp-content and save it under a php filename.
    Read more about mu-plugin here: https://codex.wordpress.org/Must_Use_Plugins

    // Redefine user notification function
    if ( !function_exists('wp_new_user_notification') ) {
        function wp_new_user_notification( $user_id, $plaintext_pass = '' ) {
            $user = new WP_User($user_id);
     
            $user_login = stripslashes($user->user_login);
            $user_email = stripslashes($user->user_email);
     
            $message  = sprintf(__('New user registration on your blog %s:'), get_option('blogname')) . "rnrn";
            $message .= sprintf(__('Username: %s'), $user_login) . "rnrn";
            $message .= sprintf(__('E-mail: %s'), $user_email) . "rn";
     
            @wp_mail(get_option('admin_email'), sprintf(__('[%s] New User Registration'), get_option('blogname')), $message);
     
            if ( empty($plaintext_pass) )
                return;
     
            $message  = __('Hi there,') . "rnrn";
            $message .= sprintf(__("Welcome to %s! Here's how to log in:"), get_option('blogname')) . "rnrn";
            $message .= wp_login_url() . "rn";
            $message .= sprintf(__('Username: %s'), $user_login) . "rn";
            $message .= sprintf(__('Password: %s'), $plaintext_pass) . "rnrn";
            $message .= sprintf(__('If you have any problems, please contact me at %s.'), get_option('admin_email')) . "rnrn";
            $message .= __('Adios!');
     
            wp_mail($user_email, sprintf(__('[%s] Your username and password'), get_option('blogname')), $message);
     
        }
    }

You must log in before being able to contribute a note or feedback.