<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.datetime.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.localtime.php',
    1 => 'localtime',
    2 => 'ローカルタイムを得る',
  ),
  'up' => 
  array (
    0 => 'ref.datetime.php',
    1 => '日付・時刻 関数',
  ),
  'prev' => 
  array (
    0 => 'function.idate.php',
    1 => 'idate',
  ),
  'next' => 
  array (
    0 => 'function.microtime.php',
    1 => 'microtime',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/datetime/functions/localtime.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.localtime" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">localtime</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">localtime</span> &mdash; <span class="dc-title">ローカルタイムを得る</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.localtime-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>localtime</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$timestamp</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$associative</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>localtime()</strong></span> 関数は、C 言語の
   同名の関数コールにより返される構造体と同じ内容の配列を返します。
  </p>
 </div>

 
 <div class="refsect1 parameters" id="refsect1-function.localtime-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
    
<dt><code class="parameter">timestamp</code></dt><dd><p class="para">
オプションのパラメータ <code class="parameter">timestamp</code> は、
<span class="type"><a href="language.types.integer.php" class="type int">int</a></span> 型の Unix タイムスタンプです。
<code class="parameter">timestamp</code> が指定されなかったり、<strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> だった場合のデフォルト値は、
現在の時刻です。言い換えると、デフォルトは
<span class="function"><a href="function.time.php" class="function">time()</a></span> の返り値となります。
</p></dd>
   
    
     <dt><code class="parameter">associative</code></dt>
     <dd>
      <p class="para">
       この関数が数値のインデックスによる通常の配列を返すか、
       連想配列を返すかを指定します。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.localtime-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   <code class="parameter">associative</code> が <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>
   に設定されるか省略された場合は、
   数値のインデックスにょる通常の配列を返します。
   <code class="parameter">associative</code> が <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> に設定された場合は、
   <span class="function"><strong>localtime()</strong></span> は C 言語の関数 localtime
   のコールにより返される構造体の全ての要素を有する連想配列を返します。
   この連想配列の各キーの名前は次のようになります。
  </p>
  <p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      &quot;tm_sec&quot; - 秒 (<code class="literal">0</code> から <code class="literal">59</code>)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_min&quot; - 分 (<code class="literal">0</code> から <code class="literal">59</code>)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_hour&quot; - 時 (<code class="literal">0</code> から <code class="literal">23</code>)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_mday&quot; - 月の日付 (<code class="literal">1</code> から <code class="literal">31</code>)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_mon&quot; - 月 (<code class="literal">0</code> (1月) から <code class="literal">11</code> (12月))
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_year&quot; - 1900 年からの年数
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_wday&quot; - 曜日 (<code class="literal">0</code> (日曜日) から <code class="literal">6</code> (土曜日))
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_yday&quot; - 年単位の日付 (<code class="literal">0</code> から <code class="literal">365</code>)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_isdst&quot; - 夏時間の適用中かどうか
     </span>
     <span class="simpara">
      適用中なら正の数、そうでなければ <code class="literal">0</code>、不明なら負の数。
     </span>
    </li>
   </ul>
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.localtime-errors">
  <h3 class="title">エラー / 例外</h3>
   
   <p class="para">
すべての日付/時刻関数は、
有効なタイムゾーンが設定されていない場合に <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
を発生させます。
<span class="function"><a href="function.date-default-timezone-set.php" class="function">date_default_timezone_set()</a></span> も参照ください。</p>
 
 </div>


 <div class="refsect1 changelog" id="refsect1-function.localtime-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.0.0</td>
       <td>
        <code class="parameter">timestamp</code> は、nullable になりました。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.localtime-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><a href="function.time.php" class="function">time()</a></span> の例</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$localtime </span><span style="color: #007700">= </span><span style="color: #0000BB">localtime</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$localtime_assoc </span><span style="color: #007700">= </span><span style="color: #0000BB">localtime</span><span style="color: #007700">(</span><span style="color: #0000BB">time</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$localtime</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$localtime_assoc</span><span style="color: #007700">);</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">Array
(
    [0] =&gt; 24
    [1] =&gt; 3
    [2] =&gt; 19
    [3] =&gt; 3
    [4] =&gt; 3
    [5] =&gt; 105
    [6] =&gt; 0
    [7] =&gt; 92
    [8] =&gt; 1
)

Array
(
    [tm_sec] =&gt; 24
    [tm_min] =&gt; 3
    [tm_hour] =&gt; 19
    [tm_mday] =&gt; 3
    [tm_mon] =&gt; 3
    [tm_year] =&gt; 105
    [tm_wday] =&gt; 0
    [tm_yday] =&gt; 92
    [tm_isdst] =&gt; 1
)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.localtime-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.getdate.php" class="function" rel="rdfs-seeAlso">getdate()</a> - 日付/時刻情報を取得する</span></li>
   </ul>
  </p>
 </div>


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