do_action( 'set_logged_in_cookie', string $logged_in_cookie, int $expire, int $expiration, int $user_id, string $scheme, string $token )
- Since
- 2.6.0, 4.9.0
Fires immediately before the logged-in authentication cookie is set.
Compatibility
- WordPress
- since 4.9.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$logged_in_cookiestring- The logged-in cookie value.
$expireint- The time the login grace period expires as a UNIX timestamp.
Default is 12 hours past the cookie's expiration time. $expirationint- The time when the logged-in authentication cookie expires as a UNIX timestamp.
Default is 14 days from now. $user_idint- User ID.
$schemestring- Authentication scheme. Default 'logged_in'.
$tokenstring- User's session token to use for this cookie.
Where this hook fires · 1
wp-includes/pluggable.php:1167wp_set_auth_cookie()
Source code
<?php * @param int $expiration The time when the logged-in authentication cookie expires as a UNIX timestamp. * Default is 14 days from now. * @param int $user_id User ID. * @param string $scheme Authentication scheme. Default 'logged_in'. * @param string $token User's session token to use for this cookie. */ do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in', $token ); /** * 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.Changelog
Introduced in 2.6.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
4.9.0
The
$token parameter was added.from the docblock2.6.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.