Skip to content
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.

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

Fix auth cookie documentation and remove unnecessary filter in wp_set_auth_cookie() #8648

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

himanshupathak95
Copy link

@himanshupathak95 himanshupathak95 commented Apr 3, 2025

Trac ticket: https://core.trac.wordpress.org/ticket/63230

The documentation for wp_set_auth_cookie() incorrectly stated that non-"Remember me" logins expire in two days. In reality, they are session cookies (they expire on the browser's close). Additionally, the auth_cookie_expiration filter was redundantly applied for non-persistent logins.

This PR -

  • Updates the docblock to clarify session cookie behavior.
  • Removes the auth_cookie_expiration filter call when $remember is false, as the browser ignores the filtered expiration time in this case.

@himanshupathak95 himanshupathak95 changed the title Fix/63230 auth cookie documentation Docs: Correct wp_set_auth_cookie() expiration documentation and remove redundant filter. Apr 3, 2025
@himanshupathak95 himanshupathak95 marked this pull request as ready for review April 3, 2025 22:12
Copy link

github-actions bot commented Apr 3, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props abcd95, dilipbheda.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@himanshupathak95 himanshupathak95 changed the title Docs: Correct wp_set_auth_cookie() expiration documentation and remove redundant filter. Fix auth cookie documentation and remove unnecessary filter in wp_set_auth_cookie() Apr 3, 2025
Copy link

github-actions bot commented Apr 3, 2025

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@dilipbheda
Copy link

@himanshupathak95 We can remove the else block and initialize the variable first. The $remember condition will override it if true.

diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php
index e7ce2edb41..56b117636d 100644
--- a/src/wp-includes/pluggable.php
+++ b/src/wp-includes/pluggable.php
@@ -984,6 +984,9 @@ if ( ! function_exists( 'wp_set_auth_cookie' ) ) :
 	 * @param string      $token    Optional. User's session token to use for this cookie.
 	 */
 	function wp_set_auth_cookie( $user_id, $remember = false, $secure = '', $token = '' ) {
+		$expire     = 0;
+		$expiration = time() + ( 2 * DAY_IN_SECONDS );
+
 		if ( $remember ) {
 			/**
 			 * Filters the duration of the authentication cookie expiration period.
@@ -1001,10 +1004,6 @@ if ( ! function_exists( 'wp_set_auth_cookie' ) ) :
 			 * Needed for the login grace period in wp_validate_auth_cookie().
 			 */
 			$expire = $expiration + ( 12 * HOUR_IN_SECONDS );
-		} else {
-			/** This filter is documented in wp-includes/pluggable.php */
-			$expiration = time() + apply_filters( 'auth_cookie_expiration', 2 * DAY_IN_SECONDS, $user_id, $remember );
-			$expire     = 0;
 		}
 
 		if ( '' === $secure ) {

@himanshupathak95 himanshupathak95 force-pushed the fix/63230-auth-cookie-documentation branch from d659227 to 50fa6a9 Compare April 8, 2025 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants