PHP 複数の値を返す関数を定義する

目的

• 複数の値を返す関数を定義する方法をメモ的にまとめる

情報

• 筆者は下記サービスを使って記事内で紹介するソースの動作確認を行った。
  • https://paiza.io/ja

方法

• 下記のように戻り値を配列状にして上げることで複数の値を返す関数を定義する事ができる。

  function returnStr()
  {
      $str_1 = '１つ目の文字列';
      $str_2 = '2つ目の文字列';
  
      return [$str_1, $str_2];
  }
  

• 下記のように記載することで戻り値を配列状に取得する。

  function returnStr()
  {
      $str_1 = '１つ目の文字列';
      $str_2 = '2つ目の文字列';
  
      return [$str_1, $str_2];
  }
  
  $returnStrArray = returnStr();
  
  var_dump($returnStrArray);
  

• 下記のようにlist戻り値の取得にlist関数（厳密には関数ではない）を用いるとそれぞれの戻り値各々を別々の変数へ格納する事ができる。

  function returnStr()
  {
      $str_1 = '１つ目の文字列';
      $str_2 = '2つ目の文字列';
  
      return [$str_1, $str_2];
  }
  
  list($returnStr_1, $returnStr_2) = returnStr();
  
  var_dump($returnStr_1);
  var_dump($returnStr_2);
  

参考文献

• https://www.php.net/manual/ja/function.list.php