Changeset 27149

Timestamp:

02/09/2014 09:07:01 PM (11 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for wp_new_user_notification().

Props antorome for the initial patch.
Fixes #26703.

File:

• trunk/src/wp-includes/pluggable.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -1274 +1274 @@
 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 = '') {