PHP 7.1.12 Released

返り値

オプションの return 文により値を返すことができます。 配列やオブジェクトを含むあらゆる型を返すことができます。 これにより、関数の実行を任意の箇所で終了し、その関数を呼び出した 箇所に制御を戻すことが出来ます。詳細に関しては return を参照してください。

注意:

return を省略した場合は NULL を返します。

return の使いかた

例1 return の使用法

<?php
function square($num)
{
    return 
$num $num;
}
echo 
square(4);   //  '16'を出力
?>

複数の値を返すことはできませんが、リストを返すことにより 同じ効果を得ることができます。

例2 複数の値を得るために配列を返す

<?php
function small_numbers()
{
    return array (
012);
}
list (
$zero$one$two) = small_numbers();
?>

関数からリファレンスを返すには、リファレンス演算子 & を関数宣 言部および変数への返り値を代入する際の両方で使用する必要があります。

例3 関数からリファレンスを返す

<?php
function &returns_reference()
{
    return 
$someref;
}

$newref =& returns_reference();
?>

リファレンスに関するさらに詳しい情報がリファレンスの説明にあります。

戻り値の型宣言

PHP 7 以降で、戻り値の型宣言が導入されました。 引数の型宣言 と同様に、戻り値の型宣言は、関数から戻される値の型を指定します。 戻り値の型宣言で使える は、引数の型宣言で使えるものと同じです。

厳密な型チェック は、戻り値の型宣言にも影響を及ぼします。デフォルトの弱い型付けでは、 もし戻り値の型が正しいものではなくても、自動的に型変換を行います。 強い型付けの場合は、戻り値の型が正確に一致しなければならず、違っている場合は TypeError が発生します。

注意:

親クラスのメソッドをオーバーライドする場合、子クラスのメソッドの戻り値の型は、 親クラスで宣言されたものと同じでなければいけません。 親クラスのメソッドが戻り値の型を宣言していない場合は、 子クラスのメソッドで型宣言をすることもできます。

例4 戻り値の型宣言の基本例

<?php
function sum($a$b): float {
    return 
$a $b;
}

// 戻り値が float となることに注目
var_dump(sum(12));
?>

上の例の出力は以下となります。

float(3)

例5 強い型付けの例

<?php
declare(strict_types=1);

function 
sum($a$b): int {
    return 
$a $b;
}

var_dump(sum(12));
var_dump(sum(12.5));
?>

上の例の出力は以下となります。

int(3)

Fatal error: Uncaught TypeError: Return value of sum() must be of the type integer, float returned in - on line 5 in -:5
Stack trace:
#0 -(9): sum(1, 2.5)
#1 {main}
  thrown in - on line 5

例6 オブジェクトを返す例

<?php
class {}

function 
getC(): {
    return new 
C;
}

var_dump(getC());
?>

上の例の出力は以下となります。

object(C)#1 (0) {
}
add a note add a note

User Contributed Notes 11 notes

up
11
ryan dot jentzsch at gmail dot com
10 months ago
PHP 7.1 allows for void and null return types by preceding the type declaration with a ? -- (e.g. function canReturnNullorString(): ?string)

However resource is not allowed as a return type:

<?php
function fileOpen(string $fileName, string $mode): resource
{
   
$handle = fopen($fileName, $mode);
    if (
$handle !== false)
    {
        return
$handle;
    }
}

$resourceHandle = fileOpen("myfile.txt", "r");
?>

Errors with:
Fatal error: Uncaught TypeError: Return value of fileOpen() must be an instance of resource, resource returned.
up
26
rstaveley at seseit dot com
7 years ago
Developers with a C background may expect pass by reference semantics for arrays. It may be surprising that  pass by value is used for arrays just like scalars. Objects are implicitly passed by reference.

<?php

# (1) Objects are always passed by reference and returned by reference

class Obj {
    public
$x;
}

function
obj_inc_x($obj) {
   
$obj->x++;
    return
$obj;
}

$obj = new Obj();
$obj->x = 1;

$obj2 = obj_inc_x($obj);
obj_inc_x($obj2);

print
$obj->x . ', ' . $obj2->x . "\n";

# (2) Scalars are not passed by reference or returned as such

function scalar_inc_x($x) {
   
$x++;
    return
$x;
}

$x = 1;

$x2 = scalar_inc_x($x);
scalar_inc_x($x2);

print
$x . ', ' . $x2 . "\n";

# (3) You have to force pass by reference and return by reference on scalars

function &scalar_ref_inc_x(&$x) {
   
$x++;
    return
$x;
}

$x = 1;

$x2 =& scalar_ref_inc_x($x);    # Need reference here as well as the function sig
scalar_ref_inc_x($x2);

print
$x . ', ' . $x2 . "\n";

# (4) Arrays use pass by value sematics just like scalars

function array_inc_x($array) {
   
$array{'x'}++;
    return
$array;
}

$array = array();
$array['x'] = 1;

$array2 = array_inc_x($array);
array_inc_x($array2);

print
$array['x'] . ', ' . $array2['x'] . "\n";

# (5) You have to force pass by reference and return by reference on arrays

function &array_ref_inc_x(&$array) {
   
$array{'x'}++;
    return
$array;
}

$array = array();
$array['x'] = 1;

$array2 =& array_ref_inc_x($array); # Need reference here as well as the function sig
array_ref_inc_x($array2);

print
$array['x'] . ', ' . $array2['x'] . "\n";
up
15
bgalloway at citycarshare dot org
9 years ago
Be careful about using "do this thing or die()" logic in your return lines.  It doesn't work as you'd expect:

<?php
function myfunc1() {
    return(
'thingy' or die('otherthingy'));
}
function
myfunc2() {
    return
'thingy' or die('otherthingy');
}
function
myfunc3() {
    return(
'thingy') or die('otherthingy');
}
function
myfunc4() {
    return
'thingy' or 'otherthingy';
}
function
myfunc5() {
   
$x = 'thingy' or 'otherthingy'; return $x;
}
echo
myfunc1(). "\n". myfunc2(). "\n". myfunc3(). "\n". myfunc4(). "\n". myfunc5(). "\n";
?>

Only myfunc5() returns 'thingy' - the rest return 1.
up
12
ryan dot jentzsch at gmail dot com
2 years ago
PHP 7 return types if specified can not return a null.
For example:
<?php
declare(strict_types=1);

function
add2ints(int $x, int $y):int
{
   
$z = $x + $y;
    if (
$z===0)
    {
        return
null;
    }
    return
$z;
}
$a = add2ints(3, 4);
echo
is_null($a) ? 'Null' : $a;
$b = add2ints(-2, 2);
echo
is_null($b) ? 'Null' : $b;
exit();

Output:
7
Process finished with
exit code 139
up
12
nick at itomic.com
14 years ago
Functions which return references, may return a NULL value. This is inconsistent with the fact that function parameters passed by reference can't be passed as NULL (or in fact anything which isnt a variable).

i.e.

<?php

function &testRet()
{
    return
NULL;
}

if (
testRet() === NULL)
{
    echo
"NULL";
}
?>

parses fine and echoes NULL
up
1
k-gun !! mail
11 months ago
With 7.1, these are possible yet;

<?php
function ret_void(): void {
   
// do something but no return any value
    // if needs to break fn exec for any reason simply write return;
   
if (...) {
        return;
// break
        // return null; // even this NO!
   
}

   
$db->doSomething();
   
// no need return call anymore
}

function
ret_nullable() ?int {
    if (...) {
        return
123;
    } else {
        return
null; // MUST!
   
}
}
?>
up
0
Ahmed KOOLI
1 month ago
If a function/method parameter has a type declaration , then php compiler will check it the moment of invocation regardless if strict_types is set to 1 or 0 or not set at all.

However, php will check parameters types on build in php functions when  strict_types is set to 1;
up
0
Vidmantas Maskoliunas
1 year ago
Note: the function does not have "alternative syntax" as if/endif, while/endwhile, and colon (:) here is used to define returning type and not to mark where the block statement begins.
up
-5
ian at NO_SPAM dot verteron dot net
14 years ago
In reference to the poster above, an additional (better?) way to return multiple values from a function is to use list(). For example:

function fn($a, $b)
{
   # complex stuff

   return array(
      $a * $b,
      $a + $b,
   );
}

list($product, $sum) = fn(3, 4);

echo $product; # prints 12
echo $sum; # prints 7
up
-3
Nathan Salter
1 year ago
Just a quick clarification on whether variables are passed by reference or not. Variables are always passed using a pointer, and if the variable is modified, it is copied and re-assigned. For example:

<?php

function byPointer($x) {
    return
$x / 3; // Does not modify or create a copy of $x
}

function
copied($x) {
   
$x++; // At this point, creates a copy of $x to be used in local scope
   
return $x;
}

class
Obj {
    public function
performAction() {}
    public
$y;
}

function
objPointer(Obj $x) {
   
$x->performAction(); //works on $x
   
$x->y = '150'; //works on $x
   
$x = new Obj(); // Does not modify $x outside of function
   
$x->y = '250';
}

function
objReference(Obj &$x) {
   
$x->performAction(); //works on $x
   
$x->y = '150'; //works on $x
   
$x = new Obj(); // Modifies original $x outside of function
   
$x->y = '250';
}

$x = new Obj();
$x->y = '10';

objPointer($x);

echo
"Post Pointer: {$x->y}\n";

$x->y = '10';
objReference($x);

echo
"Post Reference: {$x->y}\n";

?>

This will output:
Post Pointer: 150
Post Reference: 250

So make sure when writing functions that if you want to pass by reference you actually mean by reference, and not using standard PHP pointers
up
-8
ortreum
1 year ago
I like this method of concatinating methods by returning $this. It makes my code more readable. If the returned value is not an object it will fail and you find mistakes easier.

<?php
class Dummy {

    private
$result;

    function
__construct()
    {
       
$this->result =
           
$this
               
->setStuff('abc')
                ->
generateResult()
            ;
    }
   
    function
setStuff($value)
    {
       
// do something
       
return $this;
    }

    function
generateResult()
    {
        return [
'the result'];
    }

    function
getResult()
    {
        return
$this->result;
    }

}
?>
To Top