password_needs_rehash

Function • Params and return types changed in PHP 8.0

Checks if the given hash matches the given options.

PHP 5.3-5.4
PHP 5.5
Added
PHP 5.6
PHP 7
PHP 8.0
Improved
PHP 8.1-8.2
PHP 8.3-8.4
PHP 8.5
PHP 8.6

password_needs_rehash Function synopsis

password_needs_rehash(
    string $hash,
    string|int|null $algo,
    array $options = []
  ): bool

Parameters

$hash

Typestring

A hash created by password_hash.

$algo

Typestring|int|null

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

$algo accepts one of the following constant values:

$options

OptionalTypearrayDefault value[]

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

Return value

Typebool

Returns true if the hash should be rehashed to match the given $algo and $options, or false otherwise.

Changes to the password_needs_rehash Function

PHP 8.0

  • Return type added: bool
  • Parameter type added for parameter #1 ($hash): string
  • Parameter type added for parameter #2 ($algo): string|int|null
  • Parameter type added for parameter #3 ($options): array
  • Parameter default value added for position #3 ($options): []
  password_needs_rehash(
-     $hash,
+     string $hash,
-     $algo,
+     string|int|null $algo,
-     $options
+     array $options = []
-   )
+   ): bool

PHP 5.5

  • Function added

password_needs_rehash Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Supported Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Security-Fixes Only Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported No
PHP 5.3Unsupported No