wp_generate_user_request_key() │ WP 4.9.6

Returns a confirmation key for a user action and stores the hashed version for future comparison.

No Hooks.

Return

String. Confirmation key.

Usage

wp_generate_user_request_key( $request_id );
$request_id(int) (required)
Request ID.

Notes

  • Global. PasswordHash. $wp_hasher Portable PHP password hashing framework instance.

Changelog

Since 4.9.6 Introduced.

wp_generate_user_request_key() code WP 6.7.1

wp-includes/user.php 
function wp_generate_user_request_key( $request_id ) {
	global $wp_hasher;

	// Generate something random for a confirmation key.
	$key = wp_generate_password( 20, false );

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

	wp_update_post(
		array(
			'ID'            => $request_id,
			'post_status'   => 'request-pending',
			'post_password' => $wp_hasher->HashPassword( $key ),
		)
	);

	return $key;
}