W3cubDocs

/WordPress

WP_Recovery_Mode_Key_Service::generate_and_store_recovery_mode_key( string $token )

Creates a recovery mode key.

Parameters

$token

(string) (Required) A token generated by generate_recovery_mode_token().

Return

(string) Recovery mode key.

Source

File: wp-includes/class-wp-recovery-mode-key-service.php 

public function generate_and_store_recovery_mode_key( $token ) {

		global $wp_hasher;

		$key = wp_generate_password( 22, false );

		if ( empty( $wp_hasher ) ) {
			require_once ABSPATH . WPINC . '/class-phpass.php';
			$wp_hasher = new PasswordHash( 8, true );
		}

		$hashed = $wp_hasher->HashPassword( $key );

		$records = $this->get_keys();

		$records[ $token ] = array(
			'hashed_key' => $hashed,
			'created_at' => time(),
		);

		$this->update_keys( $records );

		/**
		 * Fires when a recovery mode key is generated.
		 *
		 * @since 5.2.0
		 *
		 * @param string $token The recovery data token.
		 * @param string $key   The recovery mode key.
		 */
		do_action( 'generate_recovery_mode_key', $token, $key );

		return $key;
	}

Uses

Uses Description
wp-includes/class-wp-recovery-mode-key-service.php: WP_Recovery_Mode_Key_Service::get_keys()

Gets the recovery key records.
wp-includes/class-wp-recovery-mode-key-service.php: WP_Recovery_Mode_Key_Service::update_keys()

Updates the recovery key records.
wp-includes/class-wp-recovery-mode-key-service.php: generate_recovery_mode_key

Fires when a recovery mode key is generated.
wp-includes/pluggable.php: wp_generate_password()

Generates a random password drawn from the defined set of characters.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.

Changelog

Version Description
5.2.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_recovery_mode_key_service/generate_and_store_recovery_mode_key