Add missing `@param` doc to `wp_check_password()` and update the `check_password` filter docs.

See #32246

Built from https://develop.svn.wordpress.org/trunk@35909


git-svn-id: http://core.svn.wordpress.org/trunk@35873 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2015-12-14 02:30:26 +00:00
parent b2e373d64d
commit 48380c58a5
2 changed files with 8 additions and 7 deletions

View File

@ -2072,8 +2072,9 @@ if ( !function_exists('wp_check_password') ) :
* against the $hash + $password * against the $hash + $password
* @uses PasswordHash::CheckPassword * @uses PasswordHash::CheckPassword
* *
* @param string $password Plaintext user's password * @param string $password Plaintext user's password
* @param string $hash Hash of the user's password to check against. * @param string $hash Hash of the user's password to check against.
* @param string|int $user_id Optional. User ID.
* @return bool False, if the $password does not match the hashed password * @return bool False, if the $password does not match the hashed password
*/ */
function wp_check_password($password, $hash, $user_id = '') { function wp_check_password($password, $hash, $user_id = '') {
@ -2093,10 +2094,10 @@ function wp_check_password($password, $hash, $user_id = '') {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param bool $check Whether the passwords match. * @param bool $check Whether the passwords match.
* @param string $password The plaintext password. * @param string $password The plaintext password.
* @param string $hash The hashed password. * @param string $hash The hashed password.
* @param int $user_id User ID. * @param string|int $user_id User ID. Can be empty.
*/ */
return apply_filters( 'check_password', $check, $password, $hash, $user_id ); return apply_filters( 'check_password', $check, $password, $hash, $user_id );
} }

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-35908'; $wp_version = '4.5-alpha-35909';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.