WP_Recovery_Mode_Cookie_Service::get_session_id_from_cookie() WordPress Method
The WP_Recovery_Mode_Cookie_Service::get_session_id_from_cookie() method is used to get the session ID from a cookie. This is used to help with recovery mode when a user's session has expired.
WP_Recovery_Mode_Cookie_Service::get_session_id_from_cookie( string $cookie = '' ) #
Gets the session identifier from the cookie.
Description
The cookie should be validated before calling this API.
Parameters
- $cookie
(string)(Optional)y specify the cookie string. If omitted, it will be retrieved from the super global.
Default value: ''
Return
(string|WP_Error) Session ID on success, or error object on failure.
Source
File: wp-includes/class-wp-recovery-mode-cookie-service.php
public function get_session_id_from_cookie( $cookie = '' ) {
if ( ! $cookie ) {
if ( empty( $_COOKIE[ RECOVERY_MODE_COOKIE ] ) ) {
return new WP_Error( 'no_cookie', __( 'No cookie present.' ) );
}
$cookie = $_COOKIE[ RECOVERY_MODE_COOKIE ];
}
$parts = $this->parse_cookie( $cookie );
if ( is_wp_error( $parts ) ) {
return $parts;
}
list( , , $random ) = $parts;
return sha1( $random );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.2.0 | Introduced. |