Home/ Manual/ hash / functions/ hash_file

hash_file

PHP function Edit on GitHub ✎

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

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 (e.g. "sha256"). 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, Falseforfailure.

Changelog

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

Examples

Using hash_file()

php

<?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:

output

68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483