hash

Generate a hash value (message digest)

Description

string hash(
    string $algo,
    string $data,
    bool $binary = false,
    array $options = []
)

Parameters

algo

Name of selected hashing algorithm (e.g. "sha256"). For a list of supported algorithms see hash_algos.

data

Message to be hashed.

binary

When set to true, outputs raw binary data. false outputs lowercase hexits.

options

An array of options for the various hashing algorithms:

'seed' (int)
Supported by MurmurHash3 and XXHash variants.
'secret' (string)
Supported by xxh3 and xxh128.

Return Values

Returns a string containing the calculated message digest as lowercase hexits unless binary is set to true in which case the raw binary representation of the message digest is returned.

Errors/Exceptions

Throws a ValueError exception if algo is unknown.

Changelog

Version Description
8.1.0 The options parameter has been added.
8.0.0 Now throws a ValueError exception if algo is unknown; previously, false was returned and an E_WARNING message was emitted.

Examples

Example #1 A hash example

<?php
echo hash('sha256', 'The quick brown fox jumped over the lazy dog.');
?>

The above example will output:

68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483

See Also

  • hash_init
  • hash_file
  • hash_hmac