wp_hash_password( string $password ): string
- Since
- 2.5.0
- Source
wp-includes/pluggable.php:2612
Description
For integration with other applications, this function can be overwritten to instead use the other package password hashing algorithm.
Compatibility
- WordPress
- since 2.5.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$passwordstring- Plain text user password to hash.
Return value
string- The hash string of the password.
Performance profile
How much work a call to wp_hash_password() 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
- 9–19
- Plugin surface
- None
- Called by
- 5
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 19.
Nothing here hands control to plugin code.
5 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_hash_password() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9–19 | ->HashPassword() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 19 | 9–19 | 1 | |
| 8.5 | 19 | 9–19 | 1 | |
| 8.4 | 19 | 9–19 | 1 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 21 | 11–21 | 1 | |
| 8.2 | 21 | 11–21 | 1 | |
| 8.1 | 21 | 11–21 | 1 | |
| 7.4 | 21 | 11–21 | 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 · 1
Used by · 5
- WP_Application_Passwords::create_new_application_password()Creates a new application password.
- wp_check_password()Checks a plaintext password against a hashed password.
- wp_insert_user()Inserts a user into the database.
- wp_set_password()Updates the user's password with a new hashed one.
- wp_update_user()Updates a user in the database.
Source code
function wp_hash_password( $password ) { global $wp_hasher; if ( empty( $wp_hasher ) ) { require_once ABSPATH . WPINC . '/class-phpass.php'; // By default, use the portable hash from phpass. $wp_hasher = new PasswordHash( 8, true ); } return $wp_hasher->HashPassword( trim( $password ) ); }Changelog
Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/pluggable.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.