Changeset 35909

Timestamp:

12/14/2015 02:29:04 AM (9 years ago)

Author:

johnbillion

Message:

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

See #32246

File:

• trunk/src/wp-includes/pluggable.php (modified) (2 diffs)

trunk/src/wp-includes/pluggable.php

@@ -2073 +2073 @@
  * @uses PasswordHash::CheckPassword
  *
- * @param string $password Plaintext user's password
- * @param string $hash     Hash of the user's password to check against.
+ * @param string     $password Plaintext user's password
+ * @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
  */
@@ -2094 +2095 @@
          * @since 2.5.0
          *
-         * @param bool   $check    Whether the passwords match.
-         * @param string $password The plaintext password.
-         * @param string $hash     The hashed password.
-         * @param int    $user_id  User ID.
+         * @param bool       $check    Whether the passwords match.
+         * @param string     $password The plaintext password.
+         * @param string     $hash     The hashed password.
+         * @param string|int $user_id  User ID. Can be empty.
          */
         return apply_filters( 'check_password', $check, $password, $hash, $user_id );