wp_verify_fast_hash( string $message, string $hash ): bool
- Since
- 6.8.0
- Source
wp-includes/functions.php:9386
Description
The function uses Sodium to hash the message and compare it to the hashed value. If the hash is not a generic hash, the hash is treated as a phpass portable hash in order to provide backward compatibility for passwords and security keys which were hashed using phpass prior to WordPress 6.8.0.
Compatibility
- WordPress
- since 6.8.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 4 of the 5 tracked releases, added in 6.8.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$messagestring- The plaintext message.
$hashstring- Hash of the message to check against.
Return value
bool- Whether the message matches the hashed message.
Performance profile
How much work a call to wp_verify_fast_hash() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 13–19
- Plugin surface
- None
- Called by
- 4
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 28.
Nothing here hands control to plugin code.
4 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_verify_fast_hash() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$hash | 13 | wp_fast_hash(), hash_equals() |
!$hash | 19 | ->CheckPassword() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 28 | 13–19 | 1 | |
| 8.5 | 28 | 13–19 | 1 | |
| 8.4 | 28 | 13–19 | 1 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 31 | 16–22 | 1 | |
| 8.2 | 31 | 16–22 | 1 | |
| 8.1 | 31 | 16–22 | 1 | |
| 7.4 | 31 | 16–22 | 1 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
- wp_fast_hash()Returns a cryptographically secure hash of a message using a fast generic hash function.
- new PasswordHash(8, \true)::CheckPassword()
- PasswordHash::__construct()
Used by · 4
- WP_Application_Passwords::check_password()Checks a plaintext application password against a hashed password.
- WP_Recovery_Mode_Key_Service::validate_recovery_mode_key()Verifies if the recovery mode key is correct.
- check_password_reset_key()Retrieves a user row based on password reset key and login.
- wp_validate_user_request_key()Validates a user request by comparing the key with the request's key.
Source code
function wp_verify_fast_hash( #[\SensitiveParameter] string $message, string $hash): bool { if ( ! str_starts_with( $hash, '$generic$' ) ) { // Back-compat for old phpass hashes. require_once ABSPATH . WPINC . '/class-phpass.php'; return ( new PasswordHash( 8, true ) )->CheckPassword( $message, $hash ); } return hash_equals( $hash, wp_fast_hash( $message ) );}Changelog
Introduced in 6.8.0. Unchanged from 6.8.8 through 7.1.0.
Signature, return type and hooks compared across 4 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.