WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_fast_hash()

wp_fast_hash( string $message ): string

In this article

Back to top

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

Description

Use the wp_verify_fast_hash() function to verify the hash.

This function does not salt the value prior to being hashed, therefore input to this function must originate from a random generator with sufficiently high entropy, preferably greater than 128 bits. This function is used internally in WordPress to hash security keys and application passwords which are generated with high entropy.

Important:

  • This function must not be used for hashing user-generated passwords. Use wp_hash_password() for that.
  • This function must not be used for hashing other low-entropy input. Use wp_hash() for that.

The BLAKE2b algorithm is used by Sodium to hash the message.

Parameters

$messagestringrequired
The message to hash.

Return

string The hash of the message.

Source

function wp_fast_hash(
	#[\SensitiveParameter]
	string $message
): string {
	$hashed = sodium_crypto_generichash( $message, 'wp_fast_hash_6.8+', 30 );
	return '$generic$' . sodium_bin2base64( $hashed, SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING );
}

View all references View on Trac View on GitHub

Used byDescription
WP_Application_Passwords::hash_password()wp-includes/class-wp-application-passwords.php

Hashes a plaintext application password.

wp_verify_fast_hash()wp-includes/functions.php

Checks whether a plaintext message matches the hashed value. Used to verify values hashed via wp_fast_hash() .

WP_Recovery_Mode_Key_Service::generate_and_store_recovery_mode_key()wp-includes/class-wp-recovery-mode-key-service.php

Creates a recovery mode key.

wp_generate_user_request_key()wp-includes/user.php

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

get_password_reset_key()wp-includes/user.php

Creates, stores, then returns a password reset key for user.

Changelog

VersionDescription
6.8.0Introduced.

User Contributed Notes

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