WordPress.org

Make WordPress Core

Changeset 37315


Ignore:
Timestamp:
04/27/2016 02:51:31 AM (4 years ago)
Author:
ericlewis
Message:

Users: Correct inline docs for cookie expiration.

Props kjbenk.
Fixes #35568.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/pluggable.php

    r37276 r37315  
    694694 *
    695695 * @param int    $user_id    User ID
    696  * @param int    $expiration Cookie expiration in seconds
     696 * @param int    $expiration The time the cookie expires as a UNIX timestamp.
    697697 * @param string $scheme     Optional. The cookie scheme to use: auth, secure_auth, or logged_in
    698698 * @param string $token      User's session token to use for this cookie
     
    727727     * @param string $cookie     Authentication cookie.
    728728     * @param int    $user_id    User ID.
    729      * @param int    $expiration Authentication cookie expiration in seconds.
     729     * @param int    $expiration The time the cookie expires as a UNIX timestamp.
    730730     * @param string $scheme     Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'.
    731731     * @param string $token      User's session token used.
     
    874874     *
    875875     * @param string $auth_cookie Authentication cookie.
    876      * @param int    $expire      Login grace period in seconds. Default 43,200 seconds, or 12 hours.
    877      * @param int    $expiration  Duration in seconds the authentication cookie should be valid.
    878      *                            Default 1,209,600 seconds, or 14 days.
     876     * @param int    $expire      The time the login grace period expires as a UNIX timestamp.
     877     *                            Default is 12 hours past the cookie's expiration time.
     878     * @param int    $expiration  The time when the authentication cookie expires as a UNIX timestamp.
     879     *                            Default is 14 days from now.
    879880     * @param int    $user_id     User ID.
    880881     * @param string $scheme      Authentication scheme. Values include 'auth', 'secure_auth', or 'logged_in'.
     
    883884
    884885    /**
    885      * Fires immediately before the secure authentication cookie is set.
     886     * Fires immediately before the logged-in authentication cookie is set.
    886887     *
    887888     * @since 2.6.0
    888889     *
    889890     * @param string $logged_in_cookie The logged-in cookie.
    890      * @param int    $expire           Login grace period in seconds. Default 43,200 seconds, or 12 hours.
    891      * @param int    $expiration       Duration in seconds the authentication cookie should be valid.
    892      *                                 Default 1,209,600 seconds, or 14 days.
     891     * @param int    $expire           The time the login grace period expires as a UNIX timestamp.
     892     *                                 Default is 12 hours past the cookie's expiration time.
     893     * @param int    $expiration       The time when the logged-in authentication cookie expires as a UNIX timestamp.
     894     *                                 Default is 14 days from now.
    893895     * @param int    $user_id          User ID.
    894896     * @param string $scheme           Authentication scheme. Default 'logged_in'.
Note: See TracChangeset for help on using the changeset viewer.