Changeset 50141

Timestamp:

02/02/2021 12:41:22 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update documentation for retrieve_password() per the documentation standards.

Follow-up to [50129], [50140].

See #34281.

File:

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

trunk/src/wp-includes/user.php

@@ -2665 +2665 @@
  * @global PasswordHash $wp_hasher  Portable PHP password hashing framework.
  *
- * @param  string       $user_login Optional user_login, default null. Uses
- *                                  `$_POST['user_login']` if `$user_login` not set.
+ * @param string $user_login Optional. Username to send a password retrieval email for.
+ *                           Defaults to `$_POST['user_login']` if not set.
  * @return true|WP_Error True when finished, WP_Error object on error.
  */