#35568 closed defect (bug) (fixed)
Incorrect documentation for the set_auth_cookie/set_logged_in_cookie actions
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 4.6 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Users | Keywords: | |
Focuses: | docs | Cc: |
Description
The set_auth_cookie
and set_logged_in_cookie
actions have a $expire
and $expiration
parameter whose description is slightly off.
The descriptions describe it as being the number of seconds the cookie will live (say, 3600
) but it's actually passed as the timestamp that it'll expire at - time() + 3600
(or in the case of $expire
it may also be 0 for no-grace-period).
It looks like this might be based on the auth_cookie_expiration
filter documentation (in which it would be 3600
).
Attachments (2)
Change History (8)
#1
@
7 years ago
- Keywords good-first-bug added
- Milestone changed from Awaiting Review to Future Release
@
7 years ago
Here is patch I created for this ticket. This is my first patch...ever so please bare with me :)
#3
@
7 years ago
- Owner set to kjbenk
- Status changed from new to assigned
Assigning to mark the good-first-bug as "claimed".
Note: See
TracTickets for help on using
tickets.
Looks like this also affects documentation for
wp_generate_auth_cookie()
and theauth_cookie
action.This is a great first bug if anyone's looking to contribute to documentation!