Title: WP_Recovery_Mode_Key_Service::generate_and_store_recovery_mode_key
Published: May 7, 2019
Last modified: August 20, 2026

---

# WP_Recovery_Mode_Key_Service::generate_and_store_recovery_mode_key( string $token ): string

## In this article

 * [Parameters](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#source)
 * [Hooks](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#hooks)
 * [Related](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#wp--skip-link--target)

Creates a recovery mode key.

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#parameters)󠁿

 `$token`stringrequired

A token generated by [WP_Recovery_Mode_Key_Service::generate_recovery_mode_token()](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_recovery_mode_token/).

## 󠀁[Return](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#return)󠁿

 string Recovery mode key.

## 󠀁[Source](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#source)󠁿

    ```php
    public function generate_and_store_recovery_mode_key( $token ) {
    	$key = wp_generate_password( 22, false );

    	$records = $this->get_keys();

    	$records[ $token ] = array(
    		'hashed_key' => wp_fast_hash( $key ),
    		'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;
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/class-wp-recovery-mode-key-service.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-includes/class-wp-recovery-mode-key-service.php#L45)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-includes/class-wp-recovery-mode-key-service.php#L45-L68)

## 󠀁[Hooks](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#hooks)󠁿

 [do_action( ‘generate_recovery_mode_key’, string $token, string $key )](https://developer.wordpress.org/reference/hooks/generate_recovery_mode_key/)

Fires when a recovery mode key is generated.

## 󠀁[Related](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#related)󠁿

| Uses | Description | 
| [wp_fast_hash()](https://developer.wordpress.org/reference/functions/wp_fast_hash/)`wp-includes/functions.php` |

Returns a cryptographically secure hash of a message using a fast generic hash function.

  | 
| [WP_Recovery_Mode_Key_Service::get_keys()](https://developer.wordpress.org/reference/classes/wp_recovery_mode_key_service/get_keys/)`wp-includes/class-wp-recovery-mode-key-service.php` |

Gets the recovery key records.

  | 
| [WP_Recovery_Mode_Key_Service::update_keys()](https://developer.wordpress.org/reference/classes/wp_recovery_mode_key_service/update_keys/)`wp-includes/class-wp-recovery-mode-key-service.php` |

Updates the recovery key records.

  | 
| [wp_generate_password()](https://developer.wordpress.org/reference/functions/wp_generate_password/)`wp-includes/pluggable.php` |

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

  | 
| [do_action()](https://developer.wordpress.org/reference/functions/do_action/)`wp-includes/plugin.php` |

Calls the callback functions that have been added to an action hook.

  |

[Show 1 more](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#)
[Show less](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#)

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/WP_Recovery_Mode_Key_Service/generate_and_store_recovery_mode_key/?output_format=md#changelog)󠁿

| Version | Description | 
| [6.8.0](https://developer.wordpress.org/reference/since/6.8.0/) | The stored key is now hashed using [wp_fast_hash()](https://developer.wordpress.org/reference/functions/wp_fast_hash/) instead of phpass. | 
| [5.2.0](https://developer.wordpress.org/reference/since/5.2.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_recovery_mode_key_service%2Fgenerate_and_store_recovery_mode_key%2F)
before being able to contribute a note or feedback.