Changeset 55164

Timestamp:

01/31/2023 08:44:58 AM (4 years ago)

Author:

audrasjb

Message:

Users: Add context to the send_auth_cookies filter.

This changeset adds $user_id, $expire, $expiration and $token parameters to provide context to send_auth_cookies hook, which allows the filter to skip sending auth cookies.

Props dd32, mukesh27, costdev, peterwilsoncc, audrasjb.
Fixes #56971.
See #39367.

File:

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

trunk/src/wp-includes/pluggable.php

@@ -1073 +1073 @@
                  *
                  * @param bool $send Whether to send auth cookies to the client.
-                 */
-                if ( ! apply_filters( 'send_auth_cookies', true ) ) {
+                 * @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.
+                 * @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.
+                 * @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.
+                 * @param string $token      User's session token to use for this cookie. Empty string when clearing cookies.
+                 */
+                if ( ! apply_filters( 'send_auth_cookies', true, $user_id, $expire, $expiration, $token ) ) {
                         return;
                 }
@@ -1102 +1111 @@
 
                 /** This filter is documented in wp-includes/pluggable.php */
-                if ( ! apply_filters( 'send_auth_cookies', true ) ) {
+                if ( ! apply_filters( 'send_auth_cookies', true, 0, 0, 0, '' ) ) {
                         return;
                 }