wp_parse_auth_cookie( string $cookie = '', string $scheme = '' ): string[]|false
- Since
- 2.7.0, 4.0.0
- Source
wp-includes/pluggable.php:1013
Compatibility
- WordPress
- since 4.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$cookiestringoptional- Authentication cookie.Default:
'' $schemestringoptional- The cookie scheme to use: 'auth', 'secure_auth', or 'logged_in'.Default:
''
Return value
string[]|false- Authentication cookie components. None of the components should be assumed to be valid as they come directly from a client-provided cookie value. If the cookie value is malformed, false is returned.
$usernamestringUser's username.$expirationstringThe time the cookie expires as a UNIX timestamp.$tokenstringUser's session token used.$hmacstringThe security hash for the cookie.$schemestringThe cookie scheme to use.
Performance profile
How much work a call to wp_parse_auth_cookie() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 12–51
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 65.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_parse_auth_cookie() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($cookie) && empty($cookie_name) | 12–18 | none |
| always | 13–29 | explode() |
empty($cookie) && empty($cookie_name) | 15–23 | is_ssl() |
empty($cookie) && !empty($cookie_name) | 26–34 | is_ssl(), explode() |
| always | 30–46 | explode(), compact() |
empty($cookie) && !empty($cookie_name) | 43–51 | is_ssl(), explode(), compact() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 65 | 12–51 | 8 | |
| 8.5 | 65 | 12–51 | 8 | |
| 8.4 | 65 | 12–51 | 8 | |
| 8.3 | 65 | 12–51 | 8 | |
| 8.2 | 65 | 12–51 | 8 | 1 more instruction than PHP 8.1 |
| 8.1 | 64 | 12–50 | 8 | |
| 7.4 | 64 | 12–50 | 8 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- is_ssl()Determines if SSL is used.
Used by · 3
- wp_get_session_token()Retrieves the current session token from the logged_in cookie.
- wp_update_user()Updates a user in the database.
- wp_validate_auth_cookie()Validates authentication cookie.
Source code
function wp_parse_auth_cookie( $cookie = '', $scheme = '' ) { if ( empty( $cookie ) ) { switch ( $scheme ) { case 'auth': $cookie_name = AUTH_COOKIE; break; case 'secure_auth': $cookie_name = SECURE_AUTH_COOKIE; break; case 'logged_in': $cookie_name = LOGGED_IN_COOKIE; break; default: if ( is_ssl() ) { $cookie_name = SECURE_AUTH_COOKIE; $scheme = 'secure_auth'; } else { $cookie_name = AUTH_COOKIE; $scheme = 'auth'; } } if ( empty( $_COOKIE[ $cookie_name ] ) ) { return false; } $cookie = $_COOKIE[ $cookie_name ]; } $cookie_elements = explode( '|', $cookie ); if ( count( $cookie_elements ) !== 4 ) { return false; } list( $username, $expiration, $token, $hmac ) = $cookie_elements; return compact( 'username', 'expiration', 'token', 'hmac', 'scheme' ); }Changelog
Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$token element was added to the return value.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/pluggable.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.