<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/language.functions.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'functions.returning-values.php',
    1 => '戻り値',
    2 => '戻り値',
  ),
  'up' => 
  array (
    0 => 'language.functions.php',
    1 => '関数',
  ),
  'prev' => 
  array (
    0 => 'functions.arguments.php',
    1 => '関数のパラメーターと引数',
  ),
  'next' => 
  array (
    0 => 'functions.variable-functions.php',
    1 => '可変関数',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'language/functions.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="functions.returning-values" class="sect1">
   <h2 class="title">戻り値</h2>
 
   <p class="para">
    オプションの return 文により値を返すことができます。
    配列やオブジェクトを含むあらゆる型を返すことができます。
    これにより、関数の実行を任意の箇所で終了し、その関数を呼び出した
    箇所に制御を戻すことが出来ます。詳細に関しては
    <span class="function"><a href="function.return.php" class="function">return</a></span> を参照ください。
   </p>

   <blockquote class="note"><p><strong class="note">注意</strong>: 
    <p class="para">
     <span class="function"><a href="function.return.php" class="function">return</a></span> を省略した場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> を返します。
    </p>
   </p></blockquote>

   <div class="sect2">
    <h3 class="title">return の使いかた</h3>
   <p class="para">
    <div class="example" id="example-1">
     <p><strong>例1 <span class="function"><a href="function.return.php" class="function">return</a></span> の使用法</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">square</span><span style="color: #007700">(</span><span style="color: #0000BB">$num</span><span style="color: #007700">)<br />{<br />    return </span><span style="color: #0000BB">$num </span><span style="color: #007700">* </span><span style="color: #0000BB">$num</span><span style="color: #007700">;<br />}<br />echo </span><span style="color: #0000BB">square</span><span style="color: #007700">(</span><span style="color: #0000BB">4</span><span style="color: #007700">);   </span><span style="color: #FF8000">//  '16'を出力<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
      </div>

     </div>
    </p>
 
    <p class="para">
     関数は複数の値を返すことは出来ませんが、
     配列を返すことで似たような結果を得ることができます。
    </p>
    <p class="para">

     <div class="example" id="example-2">
      <p><strong>例2 複数の値を得るために配列を返す例</strong></p>
      <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">small_numbers</span><span style="color: #007700">()<br />{<br />    return [</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">];<br />}<br /></span><span style="color: #FF8000">// 配列を展開させると、配列のそれぞれのメンバが個別に得られます。<br /></span><span style="color: #007700">[</span><span style="color: #0000BB">$zero</span><span style="color: #007700">, </span><span style="color: #0000BB">$one</span><span style="color: #007700">, </span><span style="color: #0000BB">$two</span><span style="color: #007700">] = </span><span style="color: #0000BB">small_numbers</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// PHP 7.1.0 より前のバージョンで上と同じことをするには、<br />// 言語構造 list を使うしかありません。<br /></span><span style="color: #007700">list(</span><span style="color: #0000BB">$zero</span><span style="color: #007700">, </span><span style="color: #0000BB">$one</span><span style="color: #007700">, </span><span style="color: #0000BB">$two</span><span style="color: #007700">) = </span><span style="color: #0000BB">small_numbers</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
      </div>

     </div>
    </p>
    <p class="para">
     関数からリファレンスを返すためには、
     関数宣言と戻り値を代入する変数に対して、
     リファレンス演算子 &amp; を使います:
    </p>
    <p class="para">

     <div class="example" id="example-3">
      <p><strong>例3 関数からリファレンスを返す</strong></p>
      <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function &amp;</span><span style="color: #0000BB">returns_reference</span><span style="color: #007700">()<br />{<br />    return </span><span style="color: #0000BB">$someref</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$newref </span><span style="color: #007700">=&amp; </span><span style="color: #0000BB">returns_reference</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
      </div>

     </div>

    </p>
    <p class="simpara">
     リファレンスに関する詳細は、<a href="language.references.php" class="link">リファレンスの説明</a> を参照ください。
    </p>
   </div>
  </div><?php manual_footer($setup); ?>