sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Users: Correct inline docs for cookie expiration.

Browse Source 
Props kjbenk.
Fixes #35568.


git-svn-id: https://develop.svn.wordpress.org/trunk@37315 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Eric Andrew Lewis 2016-04-27 02:51:31 +00:00
parent 024c8003c9
commit ff8553ea6b
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/wp-includes/pluggable.php
View File

@ -693,7 +693,7 @@ if ( !function_exists('wp_generate_auth_cookie') ) :
* @since 2.5.0 * @since 2.5.0
* *
* @param int $user_id User ID * @param int $user_id User ID
* @param int $expiration Cookie expiration in seconds * @param int $expiration The time the cookie expires as a UNIX timestamp.
* @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
* @param string $token User's session token to use for this cookie * @param string $token User's session token to use for this cookie
* @return string Authentication cookie contents. Empty string if user does not exist. * @return string Authentication cookie contents. Empty string if user does not exist.
@ -726,7 +726,7 @@ function wp_generate_auth_cookie( $user_id, $expiration, $scheme = 'auth', $toke
* *
* @param string $cookie Authentication cookie. * @param string $cookie Authentication cookie.
* @param int $user_id User ID. * @param int $user_id User ID.
* @param int $expiration Authentication cookie expiration in seconds. * @param int $expiration The time the cookie expires as a UNIX timestamp.
* @param string $scheme Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'. * @param string $scheme Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'.
* @param string $token User's session token used. * @param string $token User's session token used.
*/ */
@ -873,23 +873,25 @@ function wp_set_auth_cookie( $user_id, $remember = false, $secure = '', $token =
* @since 2.5.0 * @since 2.5.0
* *
* @param string $auth_cookie Authentication cookie. * @param string $auth_cookie Authentication cookie.
* @param int $expire Login grace period in seconds. Default 43,200 seconds, or 12 hours. * @param int $expire The time the login grace period expires as a UNIX timestamp.
* @param int $expiration Duration in seconds the authentication cookie should be valid. * Default is 12 hours past the cookie's expiration time.
* Default 1,209,600 seconds, or 14 days. * @param int $expiration The time when the authentication cookie expires as a UNIX timestamp.
* Default is 14 days from now.
* @param int $user_id User ID. * @param int $user_id User ID.
* @param string $scheme Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'. * @param string $scheme Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'.
*/ */
do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme ); do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme );
/** /**
* Fires immediately before the secure authentication cookie is set. * Fires immediately before the logged-in authentication cookie is set.
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param string $logged_in_cookie The logged-in cookie. * @param string $logged_in_cookie The logged-in cookie.
* @param int $expire Login grace period in seconds. Default 43,200 seconds, or 12 hours. * @param int $expire The time the login grace period expires as a UNIX timestamp.
* @param int $expiration Duration in seconds the authentication cookie should be valid. * Default is 12 hours past the cookie's expiration time.
* Default 1,209,600 seconds, or 14 days. * @param int $expiration The time when the logged-in authentication cookie expires as a UNIX timestamp.
* Default is 14 days from now.
* @param int $user_id User ID. * @param int $user_id User ID.
* @param string $scheme Authentication scheme. Default 'logged_in'. * @param string $scheme Authentication scheme. Default 'logged_in'.
*/ */