hash_file

(PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL hash >= 1.1)

hash_file — Generate a hash value using the contents of a given file

Description

hash_file(
    string $algo,
    string $filename,
    bool $binary = false,
    array $options = []
): string|false

Parameters

algo: Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..). For a list of supported algorithms see hash_algos().
filename: URL describing location of file to be hashed; Supports fopen wrappers.
binary: When set to true, outputs raw binary data. false outputs lowercase hexits.
options: An array of options for the various hashing algorithms. Currently, only the "seed" parameter is supported by the MurmurHash variants.

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.

Changelog

Version	Description
8.1.0	The `options` parameter has been added.

Examples

Example #1 Using hash_file()

<?php
/* Create a file to calculate hash of */
file_put_contents('example.txt', 'The quick brown fox jumped over the lazy dog.');

echo hash_file('sha256', 'example.txt');
?>

The above example will output:

68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483

See Also

hash() - Generate a hash value (message digest)
hash_hmac_file() - Generate a keyed hash value using the HMAC method and the contents of a given file
hash_update_file() - Pump data into an active hashing context from a file
md5_file() - Calculates the md5 hash of a given file
sha1_file() - Calculate the sha1 hash of a file

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

User Contributed Notes

There are no user contributed notes for this page.