sodium_crypto_generichash_final

Function • Params and return types changed in PHP 8.0

Complete the hash.

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_generichash_final Function synopsis

sodium_crypto_generichash_final(string &$state, int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string

Parameters

$state

Passed by referenceTypestring

Hash state returned from sodium_crypto_generichash_init

$length

OptionalTypeintDefault valueSODIUM_CRYPTO_GENERICHASH_BYTES

Output length.

Note that the parameter $state is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typestring

Cryptographic hash.

Changes to the sodium_crypto_generichash_final Function

PHP 8.0

  • Return type added: string
  • Parameter type added for parameter #1 ($state): string
  • Parameter type added for parameter #2 ($length): int
  • Parameter default value added for position #2 ($length): SODIUM_CRYPTO_GENERICHASH_BYTES
- sodium_crypto_generichash_final(&$state, $length)
+ sodium_crypto_generichash_final(string &$state, int $length = SODIUM_CRYPTO_GENERICHASH_BYTES): string

PHP 7.2

  • Function added

sodium_crypto_generichash_final 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