ファイルの内容から、ハッシュ値を生成する

# hash_file

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

hash_file — ファイルの内容から、ハッシュ値を生成する

### 説明

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

### パラメータ

`algo`

  選択したアルゴリズムの名前 (例: `"sha256"`)。 サポートされているアルゴリズムの一覧は hash_algos() を参照ください。

`filename`

  ハッシュ対象となるファイルの位置を示す URL。 fopen() ラッパーをサポートしています。

`binary`

  `true` を設定すると、生のバイナリデータを出力します。 `false` の場合は小文字の 16 進数値となります。

`options`

  様々なハッシュアルゴリズム向けの、オプションの配列。 現状は、MurmurHash バリアントが `"seed"` だけをサポートしています。

### 戻り値

`binary` が true に設定されていない場合は、 メッセージダイジェストの計算結果を小文字の 16 進数値形式の文字列で 返します。もし true に設定されていた場合は、メッセージダイジェストが そのままのバイナリ形式で返されます。 失敗した場合に `false` を返します

### 変更履歴

バージョン | 説明
--- | ---
8.1.0 | `options` パラメータが追加されました。

### 例

例1 hash_file() の使用例

    <?php
    /* ハッシュ値を計算するファイルを作成します */
    file_put_contents('example.txt', 'The quick brown fox jumped over the lazy dog.');

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

上の例の出力は以下となります。

    68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483

### 参考

- hash_init() - 段階的なハッシュコンテキストを初期化する
- hash_hmac_file() - HMAC 方式を使用して、指定されたファイルの内容からハッシュ値を生成する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open