From d670819b036ebf34e68f792d7f71b1cbdf247bbc Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 9 Feb 2014 21:07:01 +0000 Subject: [PATCH] Improve inline documentation for `wp_new_user_notification()`. Props antorome for the initial patch. Fixes #26703. git-svn-id: https://develop.svn.wordpress.org/trunk@27149 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/pluggable.php | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php index 9a7f4366a1..9fe26d518a 100644 --- a/src/wp-includes/pluggable.php +++ b/src/wp-includes/pluggable.php @@ -1273,12 +1273,14 @@ endif; if ( !function_exists('wp_new_user_notification') ) : /** - * Notify the blog admin of a new user, normally via email. + * Email login credentials to a newly-registered user. + * + * A new user registration notification is also sent to admin email. * * @since 2.0.0 * - * @param int $user_id User ID - * @param string $plaintext_pass Optional. The user's plaintext password + * @param int $user_id User ID. + * @param string $plaintext_pass Optional. The user's plaintext password. Default empty. */ function wp_new_user_notification($user_id, $plaintext_pass = '') { $user = get_userdata( $user_id );