Changeset 43642 for trunk/src/wp-includes/pluggable.php

Timestamp:

09/14/2018 01:34:50 PM (8 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve some docblocks.

See #42505

File:

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

trunk/src/wp-includes/pluggable.php

@@ -887 +887 @@
                  * @since 4.9.0 The `$token` parameter was added.
                  *
-                 * @param string $auth_cookie Authentication cookie.
+                 * @param string $auth_cookie Authentication cookie value.
                  * @param int    $expire      The time the login grace period expires as a UNIX timestamp.
                  *                            Default is 12 hours past the cookie's expiration time.
@@ -893 +893 @@
                  *                            Default is 14 days from now.
                  * @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' or 'secure_auth'.
                  * @param string $token       User's session token to use for this cookie.
                  */
@@ -904 +904 @@
                  * @since 4.9.0 The `$token` parameter was added.
                  *
-                 * @param string $logged_in_cookie The logged-in cookie.
+                 * @param string $logged_in_cookie The logged-in cookie value.
                  * @param int    $expire           The time the login grace period expires as a UNIX timestamp.
                  *                                 Default is 12 hours past the cookie's expiration time.