WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Recovery_Mode_Cookie_Service::generate_cookie()

WP_Recovery_Mode_Cookie_Service::generate_cookie(): string

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Generates the recovery mode cookie value.

Description

The cookie is a base64 encoded string with the following format:

recovery_mode|iat|rand|signature

Where "recovery_mode" is a constant string, iat is the time the cookie was generated at, rand is a randomly generated password that is also used as a session identifier and signature is an hmac of the preceding 3 parts.

Return

string Generated cookie content.

Source

private function generate_cookie() {
	$to_sign = sprintf( 'recovery_mode|%s|%s', time(), wp_generate_password( 20, false ) );
	$signed  = $this->recovery_mode_hash( $to_sign );

	return base64_encode( sprintf( '%s|%s', $to_sign, $signed ) );
}

View all references View on Trac View on GitHub

UsesDescription
WP_Recovery_Mode_Cookie_Service::recovery_mode_hash()wp-includes/class-wp-recovery-mode-cookie-service.php

Gets a form of wp_hash() specific to Recovery Mode.

wp_generate_password()wp-includes/pluggable.php

Generates a random password drawn from the defined set of characters.

Used byDescription
WP_Recovery_Mode_Cookie_Service::set_cookie()wp-includes/class-wp-recovery-mode-cookie-service.php

Sets the recovery mode cookie.

Changelog

VersionDescription
5.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.