Skip to content

Docs: Clarify behavior in wp_set_auth_cookie(). #10139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
+6 −4
Open

Docs: Clarify behavior in wp_set_auth_cookie(). #10139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/wp-includes/pluggable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1038,11 +1038,13 @@ function wp_parse_auth_cookie( $cookie = '', $scheme = '' ) {

if ( ! function_exists( 'wp_set_auth_cookie' ) ) :
/**
* Sets the authentication cookies based on user ID.
* Sets the authentication cookies for a given user ID.
*
* The $remember parameter increases the time that the cookie will be kept. The
* default the cookie is kept without remembering is two days. When $remember is
* set, the cookies will be kept for 14 days or two weeks.
* The `$remember` parameter controls cookie persistence:
* - If true, the cookie is persistent (default 14 days, filterable via `auth_cookie_expiration`).
* - If false, the cookie is a browser session cookie (expires when the browser closes).
* Internally, `auth_cookie_expiration` is still applied (default 2 days),
* but the HTTP cookie `$expire` is set to 0, so it won’t persist beyond the session.
*
* @since 2.5.0
* @since 4.3.0 Added the `$token` parameter.
Expand Down
Loading