Changeset 55165

Timestamp:

01/31/2023 12:16:23 PM (20 months ago)

Author:

SergeyBiryukov

Message:

Docs: Remove a duplicate line in the send_auth_cookies filter DocBlock.

Describe the default values for the $send and $expire parameters.

Follow-up to [55164].

See #56971, #39367.

File:

• trunk/src/wp-includes/pluggable.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -1071 +1071 @@
          *
          * @since 4.7.4
-         *
-         * @param bool $send Whether to send auth cookies to the client.
-         * @since 6.2.0 The `$user_id`, `$expire`, `$expiration` and, `$token` parameters were added.
-         *
-         * @param bool   $send       Whether to send auth cookies to the client.
+         * @since 6.2.0 The `$user_id`, `$expire`, `$expiration`, an `$token` parameters were added.
+         *
+         * @param bool   $send       Whether to send auth cookies to the client. Default true.
          * @param int    $user_id    User ID. Zero when clearing cookies.
          * @param int    $expire     The time the login grace period expires as a UNIX timestamp.
-         *                           Zero when clearing cookies.
+         *                           Default is 12 hours past the cookie's expiration time. Zero when clearing cookies.
          * @param int    $expiration The time when the logged-in authentication cookie expires as a UNIX timestamp.
          *                           Default is 14 days from now. Zero when clearing cookies.