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.


git-svn-id: https://develop.svn.wordpress.org/trunk@55164 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jb Audras 2023-01-31 08:44:58 +00:00
parent b74cfa8dd9
commit 186abb264d

View File

@ -1072,8 +1072,17 @@ if ( ! function_exists( 'wp_set_auth_cookie' ) ) :
* @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.
* @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 ) ) {
if ( ! apply_filters( 'send_auth_cookies', true, $user_id, $expire, $expiration, $token ) ) {
return;
}
@ -1101,7 +1110,7 @@ if ( ! function_exists( 'wp_clear_auth_cookie' ) ) :
do_action( 'clear_auth_cookie' );
/** 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;
}