(PHP 5 >= 5.5.0)

password_needs_rehashChecks if the given hash matches the given options


boolean password_needs_rehash ( string $hash , string $algo [, string $options ] )

This function checks to see if the supplied hash implements the algorithm and options provided. If not, it is assumed that the hash needs to be rehashed.



A hash created by password_hash().


A password algorithm constant denoting the algorithm to use when hashing the password.


An associative array containing options. See the password algorithm constants for documentation on the supported options for each algorithm.

Valor Retornado

Returns TRUE if the hash should be rehashed to match the given algo and options, or FALSE otherwise.

add a note add a note

User Contributed Notes 2 notes

nick at nickstallman dot net
9 months ago
ydroneaud this would be used on a login page, not at any other time.

So if you have a site with MD5 passwords for example, and wish to upgrade to SHA256 for additional security you would put this check in the login script.

This function will take a user's hash and say if it is SHA256, if it isn't then you can take the user's password which you still have as plaintext and rehash it as SHA256.

This lets you gradually update the hashes in your database without disrupting any features or resetting passwords.
ydroneaud at opteya dot com
9 months ago
According to the documentation, it's checking if the given hashed password string is compatible with the provided algorithm (and options, but not salt), eg. it's checking if the hashed password string was generated with the provided algorithm (and options, but not salt).

There's nothing to 'rehash' in its parameters ... especially not the already hashed password string, and the password "stored" in the hashed password string is not supposed to be known, it's not in clear, it's a secret.

The name of the function seems misleading, this function should have been called "password_hash_compatible()" instead.

This function could be use to check if a password database/a hashed password string (hashed by function "password_hash()") need to be upgraded to a stronger password hashing/storage scheme: if the function returns false,  a new password will have to be set for the user, hashed with the new, stronger, algorithm/options.

One should carefully think before using this function to support multiple algorithms/options in one database, eg. support "legacy scheme" passwords + "new scheme" ...
To Top