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

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

See #34281.
Built from https://develop.svn.wordpress.org/trunk@50141


git-svn-id: http://core.svn.wordpress.org/trunk@49820 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2021-02-02 12:43:04 +00:00
parent 22188b3e85
commit c5482c9b82
2 changed files with 3 additions and 3 deletions

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 ) {