<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.array.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.array-key-exists.php',
    1 => 'array_key_exists',
    2 => '指定したキーまたは添字が配列にあるかどうかを調べる',
  ),
  'up' => 
  array (
    0 => 'ref.array.php',
    1 => '配列 関数',
  ),
  'prev' => 
  array (
    0 => 'function.array-is-list.php',
    1 => 'array_is_list',
  ),
  'next' => 
  array (
    0 => 'function.array-key-first.php',
    1 => 'array_key_first',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/array/functions/array-key-exists.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.array-key-exists" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">array_key_exists</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.7, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">array_key_exists</span> &mdash; <span class="dc-title">指定したキーまたは添字が配列にあるかどうかを調べる</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.array-key-exists-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>array_key_exists</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.float.php" class="type float">float</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>|<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span> <code class="parameter">$key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$array</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   指定した <code class="parameter">key</code> が配列に設定されている場合、
   <span class="function"><strong>array_key_exists()</strong></span> は <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を返します。
   <code class="parameter">key</code> は配列添字として使用できる全ての値を使用可能です。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.array-key-exists-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">key</code></dt>
     <dd>
      <p class="para">
       調べる値。
      </p>
     </dd>
    
    
     <dt><code class="parameter">array</code></dt>
     <dd>
      <p class="para">
       キーが存在するかどうかを調べたい配列。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.array-key-exists-returnvalues">
  <h3 class="title">戻り値</h3>
  <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> を返します。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    <span class="function"><strong>array_key_exists()</strong></span> は、最初のレベルのキーだけを捜します。
    多次元配列のネストされたキーは、この関数では見つけられません。
   </p>
  </p></blockquote>
 </div>


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

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.5.0</td>
      <td>
       <code class="parameter">key</code> パラメータに
       <span class="type"><a href="language.types.null.php" class="type null">null</a></span> を指定することは、推奨されなくなりました。
       代わりに、空文字列を使ってください。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">key</code> パラメータは
       <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>, <span class="type"><a href="language.types.float.php" class="type float">float</a></span>, <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>,
       <span class="type"><a href="language.types.null.php" class="type null">null</a></span>, <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>,
       <span class="type"><a href="language.types.string.php" class="type string">string</a></span> を引数として受け入れるようになりました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">array</code> に <span class="type"><a href="language.types.object.php" class="type object">object</a></span> を渡すことは、
       サポートされなくなりました。
      </td>
     </tr>

     <tr>
      <td>7.4.0</td>
      <td>
       <code class="parameter">array</code> に <span class="type"><a href="language.types.object.php" class="type object">object</a></span> を渡すことは、
       推奨されなくなりました。
       <span class="function"><a href="function.property-exists.php" class="function">property_exists()</a></span> を代わりに使ってください。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>



 <div class="refsect1 examples" id="refsect1-function.array-key-exists-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>array_key_exists()</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 />$searchArray </span><span style="color: #007700">= [</span><span style="color: #DD0000">'first' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">'second' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">4</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">array_key_exists</span><span style="color: #007700">(</span><span style="color: #DD0000">'first'</span><span style="color: #007700">, </span><span style="color: #0000BB">$searchArray</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">bool(true)</pre>
</div>
    </div>
   </div>
  </p>
  <div class="example" id="example-2">
   <p><strong>例2 <span class="function"><strong>array_key_exists()</strong></span> 対 <span class="function"><a href="function.isset.php" class="function">isset()</a></span></strong></p>
   <div class="example-contents"><p>
    <span class="function"><a href="function.isset.php" class="function">isset()</a></span> は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> 値を持つ配列キーに対して
    <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を返しません。一方、<span class="function"><strong>array_key_exists()</strong></span> は
    <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を返します。
   </p></div>
   <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$searchArray </span><span style="color: #007700">= [</span><span style="color: #DD0000">'first' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">null</span><span style="color: #007700">, </span><span style="color: #DD0000">'second' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">4</span><span style="color: #007700">];<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(isset(</span><span style="color: #0000BB">$searchArray</span><span style="color: #007700">[</span><span style="color: #DD0000">'first'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">array_key_exists</span><span style="color: #007700">(</span><span style="color: #DD0000">'first'</span><span style="color: #007700">, </span><span style="color: #0000BB">$searchArray</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">bool(false)
bool(true)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.array-key-exists-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.isset.php" class="function" rel="rdfs-seeAlso">isset()</a> - 変数が宣言されていること、そして null とは異なることを検査する</span></li>
    <li><span class="function"><a href="function.array-keys.php" class="function" rel="rdfs-seeAlso">array_keys()</a> - 配列のキーすべて、あるいはその一部を返す</span></li>
    <li><span class="function"><a href="function.in-array.php" class="function" rel="rdfs-seeAlso">in_array()</a> - 配列に値があるかチェックする</span></li>
    <li><span class="function"><a href="function.property-exists.php" class="function" rel="rdfs-seeAlso">property_exists()</a> - オブジェクトもしくはクラスにプロパティが存在するかどうかを調べる</span></li>
   </ul>
  </p>
 </div>

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