PHPの関数：定義、戻り値、引数、型宣言

PHPの関数は、functionキーワード、名前、引数リスト、本体で定義し、returnで呼び出し元に値を返します。function add(int $a, int $b): int { return $a + $b; }で定義し、add(2, 3)で呼び出すと5が返ります。

<?php
function greet(string $name): string
{
    return "Hello, $name";
}

function add(int $a, int $b): int
{
    return $a + $b;
}

echo greet('Ada'), "\n";
echo add(2, 3), "\n";
echo add(add(1, 2), 10), "\n";

引数の前のstringとintは型宣言で、括弧のあとの: stringは戻り値の型です。どちらも任意ですが、ミスを早めに見つけ、関数が何を期待しているかを示してくれます。

戻り値と複数の値を返す方法

returnは関数をすぐに終わらせます。returnのない関数や、値なしのreturn;はnullを返します。効果のためだけに呼ぶ関数には: voidを宣言します。関数が返す値は1つですが、その値を配列にして、呼び出し側で分割代入できます。

<?php
function grade(int $score): string
{
    if ($score >= 90) {
        return 'A';
    }
    return $score >= 75 ? 'B' : 'C';   // reached only below 90
}

function stats(array $numbers): array
{
    return [
        'min' => min($numbers),
        'max' => max($numbers),
        'avg' => array_sum($numbers) / count($numbers),
    ];
}

function logLine(string $msg): void
{
    echo "[log] $msg\n";
}

echo grade(95), grade(80), grade(40), "\n";

['min' => $min, 'max' => $max, 'avg' => $avg] = stats([4, 8, 15, 16, 23, 42]);
echo "min $min, max $max, average $avg\n";

[$quotient, $remainder] = [intdiv(17, 5), 17 % 5];
echo "17 / 5 = $quotient remainder $remainder\n";

var_dump(logLine('saved'));   // a void function returns null

[...] =のほかの形は分割代入を参照してください。

デフォルト引数と名前付き引数

= valueを付けた引数は任意で、呼び出し側は省略できます。任意の引数は必須の引数のあとに置きます。PHP 8.0以降は名前付き引数を使えば、呼び出し側が任意の引数を名前で渡せるので、不要な任意の引数を飛ばせます。

<?php
function makeTag(string $text, string $tag = 'p', ?string $class = null, bool $escape = true): string
{
    $body = $escape ? htmlspecialchars($text) : $text;
    $attr = $class !== null ? " class=\"$class\"" : '';
    return "<$tag$attr>$body</$tag>";
}

echo makeTag('Hello'), "\n";
echo makeTag('Title', 'h1'), "\n";

// Named arguments: skip $tag and $class, set only $escape
echo makeTag('<b>bold</b>', escape: false), "\n";
echo makeTag(class: 'note', text: 'Order does not matter'), "\n";

名前付き引数は組み込み関数の呼び出しも読みやすくします：str_pad('7', 3, '0', pad_type: STR_PAD_LEFT)。引数名は関数の公開インターフェースの一部になるので、引数名を変えると名前で呼んでいる呼び出し側が壊れることがあります。

参照渡し

PHPは通常、各引数のコピーを渡すので、関数は呼び出し元の変数を変更できません。引数の前に&を付けると、変数そのものが渡されます。sort()のような組み込み関数はこの方法で動いています。

<?php
function addOne(int $n): void
{
    $n++;          // changes the copy only
}

function addOneRef(int &$n): void
{
    $n++;          // changes the caller's variable
}

$a = 5;
addOne($a);
echo $a, "\n";

addOneRef($a);
echo $a, "\n";

function addItem(array &$cart, string $item): void
{
    $cart[] = $item;
}

$cart = [];
addItem($cart, 'apple');
addItem($cart, 'pear');
print_r($cart);

たいていは、引数を変更するより新しい値を返すほうがわかりやすいコードになります。関数が本当に何かをその場で変更するためのものであるときに、参照を使いましょう。

型宣言とstrict_types

デフォルトでは、PHPは可能なら引数を宣言された型に変換します。add("5", 3)は"5"を5に変えます。ファイルのいちばん先頭にdeclare(strict_types=1);を書くと、そのファイルでの呼び出しではこの変換が無効になり、間違った型は変換されずにTypeErrorが投げられます。

<?php
declare(strict_types=1);
// This throws a TypeError on purpose: "5" is a string, not an int

function add(int $a, int $b): int
{
    return $a + $b;
}

echo add(2, 3), "\n";
echo add("5", 3), "\n";

declareの行がなければ、同じ呼び出しは8と出力します。"five"のような数値でない文字列は、どちらのモードでもTypeErrorを投げます。

引数と戻り値に宣言できる型は次のとおりです。

<?php
// ?string: a string or null
function findUser(int $id): ?string
{
    $users = [1 => 'Ada', 2 => 'Linus'];
    return $users[$id] ?? null;
}

// int|float: a union type (PHP 8.0)
function half(int|float $n): float
{
    return $n / 2;
}

// mixed: anything at all
function describe(mixed $value): string
{
    return get_debug_type($value);
}

var_dump(findUser(1), findUser(9));
var_dump(half(5), half(2.5));
echo describe([1, 2]), ' ', describe(null), ' ', describe(1.5), "\n";

neverは、常に例外を投げるか終了する関数の戻り値の型です。クラス名やインターフェース名も型として使えます。

...$argsで可変個の引数を受け取る

...$numbersは、任意の数の引数を配列に集めます。呼び出し側で同じ...を使うと、配列を別々の引数に展開します。

<?php
function sum(int ...$numbers): int
{
    return array_sum($numbers);
}

echo sum(), "\n";
echo sum(1, 2, 3), "\n";

$values = [10, 20, 30];
echo sum(...$values), "\n";          // spread an array

function logMessage(string $level, string ...$parts): string
{
    return strtoupper($level) . ': ' . implode(' ', $parts);
}

echo logMessage('info', 'user', 'Ada', 'logged in'), "\n";

関数の中で外側の変数を使う

関数には独自のスコープがあります。外側で定義した変数は中からは見えず、JavaScriptから来た人は驚くところです。

<?php
$taxRate = 0.2;

function priceWithTax(float $price): float
{
    return $price * (1 + $taxRate);   // $taxRate is undefined here
}

Warning: Undefined variable $taxRate in /path/to/index.php on line 6

そして関数は税抜きの価格を返します。代わりに値を引数として渡しましょう。そうすれば関数が何に依存しているかがはっきりし、テストもしやすくなります。

<?php
$taxRate = 0.2;

function priceWithTax(float $price, float $taxRate): float
{
    return $price * (1 + $taxRate);
}

echo priceWithTax(100, $taxRate), "\n";
echo priceWithTax(100, 0.1), "\n";

globalキーワードでも動きますが、依存関係を隠してしまいます。これについては変数のスコープで扱っています。array_map()のコールバックのように、ほかの関数に渡す短い関数については、useで外側の変数を取り込める無名関数を参照してください。