PHPDoc fixes for wp_validate_logged_in_cookie(), introduced in 3.9.

See #27700.


git-svn-id: https://develop.svn.wordpress.org/trunk@28015 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-04-07 21:43:00 +00:00
parent ef4d73dafc
commit 7736833039

View File

@ -220,18 +220,19 @@ function wp_authenticate_spam_check( $user ) {
}
/**
* Validates logged in cookie.
* Validate the logged-in cookie.
*
* Checks the logged_in cookie if the previous auth cookie could not be
* Checks the logged-in cookie if the previous auth cookie could not be
* validated and parsed.
*
* This is a callback for the determine_current_user filter, rather than API.
*
* @since 3.9.0
*
* @param int|boolean $user The user ID (or false) as received from the determine_current_user filter.
* @return int|boolean User ID if validated, or false otherwise. If it receives a user ID from
* an earlier filter callback, that value is returned.
* @param int|bool $user The user ID (or false) as received from the
* determine_current_user filter.
* @return int|bool User ID if validated, false otherwise. If a user ID from
* an earlier filter callback is received, that value is returned.
*/
function wp_validate_logged_in_cookie( $user_id ) {
if ( $user_id ) {