wp_generate_user_request_key() – Function

wp_generate_user_request_key( int $request_id ): string

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

Parameters

$request_idintrequired: Request ID.

Return

string Confirmation key.

Source

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

	// Save the key, hashed.
	wp_update_post(
		array(
			'ID'            => $request_id,
			'post_status'   => 'request-pending',
			'post_password' => wp_fast_hash( $key ),
		)
	);

	return $key;
}

View all references View on Trac View on GitHub

Uses	Description
wp_fast_hash()`wp-includes/functions.php`	Returns a cryptographically secure hash of a message using a fast generic hash function.
wp_generate_password()`wp-includes/pluggable.php`	Generates a random password drawn from the defined set of characters.
wp_update_post()`wp-includes/post.php`	Updates a post with new post data.

Used by	Description
wp_send_user_request()`wp-includes/user.php`	Send a confirmation request email to confirm an action.

Changelog

Version	Description
4.9.6	Introduced.

User Contributed Notes

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