sodium_crypto_pwhash_str_needs_rehash

FunctionParams and return types changed in PHP 8.0

Determine whether or not to rehash a password.

PHP 5
PHP 7.0-7.1
PHP 7.2
Added
PHP 7.3-7.4
PHP 8.0
Improved
PHP 8.1
PHP 8.2
PHP 8.3
PHP 8.4
PHP 8.5

sodium_crypto_pwhash_str_needs_rehash Function synopsis

sodium_crypto_pwhash_str_needs_rehash(
    string $password,
    int $opslimit,
    int $memlimit
  ): bool

Parameters

$password

Typestring

Password hash

$opslimit

Typeint

Configured opslimit; see sodium_crypto_pwhash_str

$memlimit

Typeint

Configured memlimit; see sodium_crypto_pwhash_str

Return value

Typebool

Returns true if the provided memlimit/opslimit do not match what's stored in the hash. Returns false if they match.

Changes to the sodium_crypto_pwhash_str_needs_rehash Function

PHP 8.0

  • Return type added: bool
  • Parameter type added for parameter #1 ($password): string
  • Parameter type added for parameter #2 ($opslimit): int
  • Parameter type added for parameter #3 ($memlimit): int
  sodium_crypto_pwhash_str_needs_rehash(
-     $password,
+     string $password,
-     $opslimit,
+     int $opslimit,
-     $memlimit
+     int $memlimit
-   )
+   ): bool

PHP 7.2

  • Function added

sodium_crypto_pwhash_str_needs_rehash Function Availability

PHP VersionAvailability
PHP 8.5Future Release Yes
PHP 8.4Upcoming Release Yes
PHP 8.3Supported (Latest) Yes
PHP 8.2Supported 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 No
PHP 7.0Unsupported No
PHP 5.6Unsupported No
PHP 5.5Unsupported No
PHP 5.4Unsupported No
PHP 5.3Unsupported No