【PHP8.x】call_user_func()関数の使い方

Copy
1<?php
2
3/**
4 * call_user_func の使用例：シンプルな関数呼び出し.
5 */
6function greet(string $name): string
7{
8    return "Hello, " . $name . "!";
9}
10
11$message = call_user_func('greet', 'World');
12echo $message . PHP_EOL; // 出力: Hello, World!
13
14/**
15 * call_user_func の使用例：クラスのメソッド呼び出し.
16 */
17class Greeter
18{
19    public function greet(string $name): string
20    {
21        return "Greetings, " . $name . "!";
22    }
23}
24
25$greeter = new Greeter();
26$message = call_user_func([$greeter, 'greet'], 'User');
27echo $message . PHP_EOL; // 出力: Greetings, User!
28
29/**
30 * call_user_func の使用例：クロージャの呼び出し.
31 */
32$multiplier = function (int $x, int $y): int {
33    return $x * $y;
34};
35
36$product = call_user_func($multiplier, 5, 3);
37echo $product . PHP_EOL; // 出力: 15
38
39/**
40 * call_user_func の使用例：静的メソッドの呼び出し.
41 */
42class Calculator
43{
44    public static function add(int $a, int $b): int
45    {
46        return $a + $b;
47    }
48}
49
50$sum = call_user_func([Calculator::class, 'add'], 10, 20);
51echo $sum . PHP_EOL; // 出力: 30

call_user_func関数は、PHPにおいて非常に柔軟な関数呼び出しを可能にする関数です。第一引数 $callback には、呼び出したい関数名（文字列）、クラスのメソッドを配列 [$object, 'methodName'] 形式、またはクロージャ（無名関数）を指定します。第二引数以降 $args は、$callback で指定した関数に渡す引数を指定します。

この関数を使うことで、実行時に関数名やメソッド名を決定し、動的に呼び出すことができます。これは、特定の条件に応じて異なる処理を実行する場合や、設定ファイルなどから読み込んだ関数名を呼び出す場合に非常に便利です。

サンプルコードでは、call_user_func の様々な使用例を紹介しています。シンプルな関数呼び出し、クラスのメソッド呼び出し、クロージャの呼び出し、そして静的メソッドの呼び出し方を示しています。

例えば、call_user_func('greet', 'World') は、greet 関数を引数 'World' で呼び出し、その結果を $message に格納します。同様に、call_user_func([$greeter, 'greet'], 'User') は、Greeter クラスの $greeter オブジェクトの greet メソッドを引数 'User' で呼び出します。

call_user_func は、戻り値として $callback で指定した関数またはメソッドの実行結果を返します。引数として渡す値の型や数に制限はありませんが、$callback で指定した関数やメソッドが受け取れる引数と一致している必要があります。もし引数の不一致があった場合、PHP は警告またはエラーを発生させることがあります。

Copy
1<?php
2
3/**
4 * call_user_func と参照渡しの挙動についてデモンストレーションする関数。
5 *
6 * call_user_func は引数を値渡しで処理するため、直接的な参照渡しはできません。
7 * しかし、クロージャの 'use' キーワードを使って外部変数を参照としてキャプチャすることで、
8 * 間接的に参照渡しのような効果を得ることができます。
9 */
10function demonstrateCallUserFuncReferenceBehavior(): void
11{
12    echo "--- call_user_func と参照渡しの挙動 ---" . PHP_EOL;
13
14    // 1. call_user_func が直接的な参照渡しをサポートしない例
15    //    引数を参照渡しとして受け取るクロージャを定義します。
16    //    call_user_func は引数を値渡しでコピーするため、この方法では元の変数は変更されません。
17    $modifyByRef = function (int &$value): void {
18        $value += 10;
19        echo "  modifyByRefクロージャ内部: \$value = " . $value . PHP_EOL;
20    };
21
22    $num = 5;
23    echo "元の変数 \$num: " . $num . PHP_EOL;
24
25    echo "call_user_func で参照渡しを期待するクロージャを呼び出し..." . PHP_EOL;
26    // call_user_func は、$num の値をコピーして $modifyByRef に渡します。
27    // そのため、$modifyByRef 内部で $value を変更しても、元の $num には影響しません。
28    // PHP公式ドキュメントにも「call_user_func() will not be able to pass parameters by reference.」
29    // と明記されています。
30    call_user_func($modifyByRef, $num);
31    echo "call_user_func 呼び出し後: \$num = " . $num . PHP_EOL;
32    echo "→ 期待通り、\$num は変更されません。call_user_func は引数を値渡しで処理するためです。" . PHP_EOL . PHP_EOL;
33
34    // 2. クロージャの 'use' キーワードを使った参照キャプチャによる間接的な参照渡し
35    //    call_user_func 自体が引数を参照渡しできない制約はありますが、
36    //    クロージャの 'use (&$variable)' を使うことで、クロージャが定義されたスコープの
37    //    変数を参照としてキャプチャし、クロージャ内部から変更することが可能です。
38    $anotherNum = 10;
39    echo "元の変数 \$anotherNum: " . $anotherNum . PHP_EOL;
40
41    // 'use (&$anotherNum)' により、$anotherNum を参照としてキャプチャします。
42    // このクロージャは引数を取らないため、call_user_func の引数は不要です。
43    $modifyViaClosureUse = function () use (&$anotherNum): void {
44        $anotherNum += 20;
45        echo "  modifyViaClosureUseクロージャ内部: \$anotherNum = " . $anotherNum . PHP_EOL;
46    };
47
48    echo "call_user_func で 'use (&\$variable)' を使ったクロージャを呼び出し..." . PHP_EOL;
49    call_user_func($modifyViaClosureUse); // このクロージャは引数なしで呼び出される
50    echo "call_user_func 呼び出し後: \$anotherNum = " . $anotherNum . PHP_EOL;
51    echo "→ 期待通り、\$anotherNum が変更されました。これはクロージャが定義時に外部変数を参照としてキャプチャしたためです。" . PHP_EOL;
52}
53
54// デモンストレーション関数を実行します。
55demonstrateCallUserFuncReferenceBehavior();
56
57?>

call_user_funcは、PHPで関数やメソッドを動的に呼び出すための組み込み関数です。第一引数$callbackには、呼び出したい関数名（文字列）、クロージャ（無名関数）、またはオブジェクトのメソッド（配列形式）を指定します。第二引数以降$argsは、$callbackに渡す引数として機能し、$callbackの実行結果がcall_user_funcの戻り値となります。

この関数を使用する上で特に注意が必要なのは、渡される引数が「値渡し」で処理される点です。例えば、引数を参照渡し（&$value）で受け取るように定義されたクロージャをcall_user_funcで呼び出しても、元の変数の値は変更されません。サンプルコードの最初の例では、$numの値を変更しようとしても、call_user_funcが$numの「値」をコピーしてクロージャに渡すため、元の$numは影響を受けず、変更前の値のままです。

しかし、クロージャの特別な機能であるuseキーワードを利用することで、間接的に外部変数を変更することが可能です。サンプルコードの2つ目の例では、クロージャが定義された時点でuse (&$anotherNum)と指定することで、$anotherNum変数を「参照として」クロージャ内に取り込んでいます。このクロージャをcall_user_funcで呼び出すと、クロージャ内部で$anotherNumが変更され、それに伴い外部の$anotherNumも変更されます。これはcall_user_funcが直接引数を参照渡しするわけではなく、クロージャが定義時に外部変数を参照としてキャプチャしているためです。この方法により、call_user_funcの制約を受けつつ、外部変数を操作する柔軟なコードを書くことができます。

Copy
1<?php
2
3/**
4 * 複数の数値を合計する関数
5 * この関数を call_user_func および call_user_func_array で呼び出します。
6 *
7 * @param int ...$numbers 可変長の整数引数
8 * @return int 引数の合計値
9 */
10function sumNumbers(int ...$numbers): int
11{
12    return array_sum($numbers);
13}
14
15echo "--- call_user_func の使用例 ---" . PHP_EOL;
16// call_user_func は、呼び出す関数の引数を個別に指定します。
17// sumNumbers(10, 20, 30) と直接呼び出すのと同じように動作します。
18$result_func = call_user_func('sumNumbers', 10, 20, 30);
19echo "call_user_func の結果: " . $result_func . PHP_EOL . PHP_EOL;
20
21echo "--- call_user_func_array の使用例 ---" . PHP_EOL;
22// call_user_func_array は、呼び出す関数の引数を配列として指定します。
23// 動的に引数のリストを作成して関数を呼び出したい場合に便利です。
24$arguments = [100, 200, 300, 400];
25$result_func_array = call_user_func_array('sumNumbers', $arguments);
26echo "call_user_func_array の結果: " . $result_func_array . PHP_EOL;
27
28// クロージャ（無名関数）をコールバックとして使用する例
29$multiply = function (int $a, int $b): int {
30    return $a * $b;
31};
32
33echo PHP_EOL . "--- クロージャと call_user_func の使用例 ---" . PHP_EOL;
34$result_closure_func = call_user_func($multiply, 5, 6);
35echo "call_user_func (クロージャ) の結果: " . $result_closure_func . PHP_EOL . PHP_EOL;
36
37echo "--- クロージャと call_user_func_array の使用例 ---" . PHP_EOL;
38$closure_arguments = [7, 8];
39$result_closure_func_array = call_user_func_array($multiply, $closure_arguments);
40echo "call_user_func_array (クロージャ) の結果: " . $result_closure_func_array . PHP_EOL;

PHPのcall_user_funcとcall_user_func_arrayは、プログラムの実行中に動的に関数を呼び出す際に利用される関数です。

call_user_funcは、第一引数$callbackに呼び出したい関数名を文字列で、または関数そのものを指定します。第二引数以降の...$argsには、その関数に渡す引数を個別に並べて指定します。例えば、サンプルコードではsumNumbers関数に10, 20, 30という引数をそれぞれ渡して合計を計算しており、呼び出した関数の実行結果が戻り値として返されます。

対してcall_user_func_arrayも、第一引数$callbackに関数を指定しますが、第二引数には、呼び出す関数に渡す引数を配列としてまとめて指定します。サンプルコードでは[100, 200, 300, 400]という配列がsumNumbers関数の引数として渡され、合計値が計算されています。この方法は、引数の数が実行時に動的に決まる場合や、可変長引数を持つ関数を呼び出す際に特に役立ちます。

どちらの関数も、sumNumbersのような名前付き関数だけでなく、$multiplyのようなクロージャ（無名関数）を$callbackとして指定することも可能です。これにより、柔軟なコールバック処理を実現できます。両関数の主な違いは、呼び出す関数に引数を個別に渡すか、配列にまとめて渡すかという点にあります。

Copy
1<?php
2
3/**
4 * コールバック関数を使用して、文字列を大文字に変換する。
5 *
6 * @param string $string 変換する文字列
7 * @return string 大文字に変換された文字列
8 */
9function toUpper(string $string): string
10{
11  return strtoupper($string);
12}
13
14/**
15 * コールバック関数を使用して、文字列を指定回数繰り返す。
16 *
17 * @param string $string 繰り返す文字列
18 * @param int $times 繰り返す回数
19 * @return string 繰り返された文字列
20 */
21function repeatString(string $string, int $times): string
22{
23  return str_repeat($string, $times);
24}
25
26// コールバック関数と引数
27$callback1 = 'toUpper';
28$argument1 = 'hello';
29
30$callback2 = 'repeatString';
31$argument2 = 'world';
32$times = 3;
33
34// call_user_func を使用してコールバック関数を実行
35$result1 = call_user_func($callback1, $argument1);
36$result2 = call_user_func($callback2, $argument2, $times);
37
38// 結果を表示
39echo "Result 1: " . $result1 . PHP_EOL; // 出力: HELLO
40echo "Result 2: " . $result2 . PHP_EOL; // 出力: worldworldworld
41
42// クロージャ（無名関数）を使用する場合
43$callback3 = function (string $name) {
44    return "Hello, " . $name . "!";
45};
46
47$result3 = call_user_func($callback3, "Alice");
48
49echo "Result 3: " . $result3 . PHP_EOL; // 出力: Hello, Alice!

call_user_func関数は、PHPでコールバック関数を実行するための関数です。第一引数 $callback には、実行したい関数名（文字列）またはクロージャ（無名関数）を指定します。第二引数以降 $args には、コールバック関数に渡す引数を指定します。

サンプルコードでは、toUpper関数とrepeatString関数の2つの関数を定義しています。toUpper関数は、渡された文字列を大文字に変換して返します。repeatString関数は、渡された文字列を指定された回数だけ繰り返して返します。

call_user_funcを使って、これらの関数を文字列で指定して実行しています。例えば、call_user_func($callback1, $argument1)は、toUpper('hello')を実行するのと同じ結果になります。同様に、call_user_func($callback2, $argument2, $times)は、repeatString('world', 3)を実行するのと同じ結果になります。

クロージャ（無名関数）もcall_user_funcで実行できます。サンプルコードでは、無名関数を $callback3 に代入し、call_user_func($callback3, "Alice")で実行しています。

call_user_funcは、コールバック関数を動的に実行したい場合に便利です。コールバック関数は、関数の引数として渡される関数であり、call_user_funcを使うことで、実行時にどの関数を実行するかを決定できます。戻り値は、コールバック関数の戻り値がそのまま返されます。