<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.hash.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.hash.php',
    1 => 'hash',
    2 => 'ハッシュ値 (メッセージダイジェスト) を生成する',
  ),
  'up' => 
  array (
    0 => 'ref.hash.php',
    1 => 'Hash 関数',
  ),
  'prev' => 
  array (
    0 => 'ref.hash.php',
    1 => 'Hash 関数',
  ),
  'next' => 
  array (
    0 => 'function.hash-algos.php',
    1 => 'hash_algos',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/hash/functions/hash.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.hash" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">hash</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL hash &gt;= 1.1)</p><p class="refpurpose"><span class="refname">hash</span> &mdash; <span class="dc-title">ハッシュ値 (メッセージダイジェスト) を生成する</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.hash-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>hash</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$algo</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$binary</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = []</span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>


 </div>

 <div class="refsect1 parameters" id="refsect1-function.hash-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">algo</code></dt>
     <dd>
      <p class="para">
       選択したアルゴリズムの名前 (例: <code class="literal">&quot;sha256&quot;</code>)。
       サポートされているアルゴリズムの一覧は <span class="function"><a href="function.hash-algos.php" class="function">hash_algos()</a></span> を参照ください。
      </p>
     </dd>
    
    
     <dt><code class="parameter">data</code></dt>
     <dd>
      <p class="para">
       ハッシュするメッセージ。
      </p>
     </dd>
    
    
     <dt><code class="parameter">binary</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を設定すると、生のバイナリデータを出力します。
       <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> の場合は小文字の 16 進数値となります。
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       様々なハッシュアルゴリズム向けの、オプションの配列。
       現状は、MurmurHash バリアントが <code class="literal">&quot;seed&quot;</code>
       だけをサポートしています。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.hash-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   <code class="parameter">binary</code> が true に設定されていない場合は、
   メッセージダイジェストの計算結果を小文字の 16 進数値形式の文字列で
   返します。もし true に設定されていた場合は、メッセージダイジェストが
   そのままのバイナリ形式で返されます。
  </p>
 </div>

 
 <div class="refsect1 changelog" id="refsect1-function.hash-changelog">
  <h3 class="title">変更履歴</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>バージョン</th>
       <th>説明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.1.0</td>
       <td><code class="parameter">options</code> パラメータが追加されました。</td></tr>

      <tr>
       <td>8.0.0</td>
       <td>
        <span class="function"><strong>hash()</strong></span> は、
        <code class="parameter">algo</code> が未知の場合に、
        <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> をスローするようになりました。
        これより前のバージョンでは、<strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返していました。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.hash-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>hash()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">hash</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">, </span><span style="color: #DD0000">'The quick brown fox jumped over the lazy dog.'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>上の例の出力は以下となります。</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.hash-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.hash-init.php" class="function" rel="rdfs-seeAlso">hash_init()</a> - 段階的なハッシュコンテキストを初期化する</span></li>
    <li><span class="function"><a href="function.hash-file.php" class="function" rel="rdfs-seeAlso">hash_file()</a> - ファイルの内容から、ハッシュ値を生成する</span></li>
    <li><span class="function"><a href="function.hash-hmac.php" class="function" rel="rdfs-seeAlso">hash_hmac()</a> - HMAC 方式を使用してハッシュ値を生成する</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>