set_auth_cookie WordPress Action Hook

The set_auth_cookie hook is called whenever a user logs in to WordPress. It allows you to set the authentication cookie for the user, which is used to remember the user's login information.

do_action( 'set_auth_cookie', string $auth_cookie, int $expire, int $expiration, int $user_id, string $scheme, string $token ) #

Fires immediately before the authentication cookie is set.


Parameters

$auth_cookie

(string)Authentication cookie value.

$expire

(int)The time the login grace period expires as a UNIX timestamp. Default is 12 hours past the cookie's expiration time.

$expiration

(int)The time when the authentication cookie expires as a UNIX timestamp. Default is 14 days from now.

$user_id

(int)User ID.

$scheme

(string)Authentication scheme. Values include 'auth' or 'secure_auth'.

$token

(string)User's session token to use for this cookie.


Top ↑

Source

File: wp-includes/pluggable.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.9.0The $token parameter was added.
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More