Filter hook 'send_auth_cookies'
in WP Core File wp-includes/pluggable.php at line 1089
Description
Allows preventing auth cookies from actually being sent to the client.
Occurrences
Filename |
Line Number |
wp-includes/pluggable.php |
1089 |
wp-includes/pluggable.php |
1117 |
Parameters
Type |
Name |
Description |
bool |
$send |
Whether to send auth cookies to the client. Default true. |
int |
$expire |
The time the login grace period expires as a UNIX timestamp. Default is 12 hours past the cookie's expiration time. Zero when clearing cookies. |
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. |
int |
$user_id |
User ID. Zero when clearing cookies. |
string |
$scheme |
Authentication scheme. Values include 'auth' or 'secure_auth'. Empty string when clearing cookies. |
string |
$token |
User's session token to use for this cookie. Empty string when clearing cookies. |
PHP Doc
/**
* Allows preventing auth cookies from actually being sent to the client.
*
* @since 4.7.4
* @since 6.2.0 The `$expire`, `$expiration`, `$user_id`, `$scheme`, and `$token` parameters were added.
*
* @param bool $send Whether to send auth cookies to the client. Default true.
* @param int $expire The time the login grace period expires as a UNIX timestamp.
* 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.
* @param int $user_id User ID. Zero when clearing cookies.
* @param string $scheme Authentication scheme. Values include 'auth' or 'secure_auth'.
* Empty string when clearing cookies.
* @param string $token User's session token to use for this cookie. Empty string when clearing cookies.
*/