Changeset 45822

Timestamp:

08/17/2019 01:22:26 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for wp_set_auth_cookie() and related functions.

Props arafat, SergeyBiryukov.
Fixes #47886.

File:

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

trunk/src/wp-includes/pluggable.php

@@ -593 +593 @@
      * @global int $login_grace_period
      *
-     * @param string $cookie Optional. If used, will validate contents instead of cookie's
-     * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
-     * @return false|int False if invalid cookie, User ID if valid.
+     * @param string $cookie Optional. If used, will validate contents instead of cookie's.
+     * @param string $scheme Optional. The cookie scheme to use: 'auth', 'secure_auth', or 'logged_in'.
+     * @return false|int False if invalid cookie, user ID if valid.
      */
     function wp_validate_auth_cookie( $cookie = '', $scheme = '' ) {
@@ -698 +698 @@
 if ( ! function_exists( 'wp_generate_auth_cookie' ) ) :
     /**
-     * Generate authentication cookie contents.
+     * Generates authentication cookie contents.
      *
      * @since 2.5.0
      * @since 4.0.0 The `$token` parameter was added.
      *
-     * @param int    $user_id    User ID
+     * @param int    $user_id    User ID.
      * @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 $token      User's session token to use for this cookie
+     * @param string $scheme     Optional. The cookie scheme to use: 'auth', 'secure_auth', or 'logged_in'.
+     *                           Default 'auth'.
+     * @param string $token      User's session token to use for this cookie.
      * @return string Authentication cookie contents. Empty string if user does not exist.
      */
@@ -748 +749 @@
 if ( ! function_exists( 'wp_parse_auth_cookie' ) ) :
     /**
-     * Parse a cookie into its components
+     * Parses a cookie into its components.
      *
      * @since 2.7.0
      *
-     * @param string $cookie
-     * @param string $scheme Optional. The cookie scheme to use: auth, secure_auth, or logged_in
-     * @return array|false Authentication cookie components
+     * @param string $cookie Authentication cookie.
+     * @param string $scheme Optional. The cookie scheme to use: 'auth', 'secure_auth', or 'logged_in'.
+     * @return array|false Authentication cookie components.
      */
     function wp_parse_auth_cookie( $cookie = '', $scheme = '' ) {
@@ -797 +798 @@
 if ( ! function_exists( 'wp_set_auth_cookie' ) ) :
     /**
-     * Log in a user by setting authentication cookies.
+     * Sets the authentication cookies based on user ID.
      *
      * The $remember parameter increases the time that the cookie will be kept. The
@@ -806 +807 @@
      * @since 4.3.0 Added the `$token` parameter.
      *
-     * @param int    $user_id  User ID
-     * @param bool   $remember Whether to remember the user
+     * @param int    $user_id  User ID.
+     * @param bool   $remember Whether to remember the user.
      * @param mixed  $secure   Whether the admin cookies should only be sent over HTTPS.
-     *                         Default is_ssl().
+     *                         Default is the value of is_ssl().
      * @param string $token    Optional. User's session token to use for this cookie.
      */