[wp-trac] [WordPress Trac] #35568: Incorrect documentation for the set_auth_cookie/set_logged_in_cookie actions

[WordPress Trac]

#35568: Incorrect documentation for the set_auth_cookie/set_logged_in_cookie
actions
--------------------------+-----------------------------
 Reporter:  dd32          |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  Users         |    Version:
 Severity:  normal        |   Keywords:  needs-patch
  Focuses:  docs          |
--------------------------+-----------------------------
 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`).

--
Ticket URL: <https://core.trac.wordpress.org/ticket/35568>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform