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

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

See #34281.

git-svn-id: https://develop.svn.wordpress.org/trunk@50141 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2021-02-02 12:41:22 +00:00
parent 16cbb22700
commit 1f33c5b66f

View File

@ -2664,8 +2664,8 @@ function check_password_reset_key( $key, $login ) {
* @global wpdb $wpdb WordPress database abstraction object.
* @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.
*/
function retrieve_password( $user_login = null ) {