【PHP8.x】ReflectionFunction::invokeArgs()メソッドの使い方

invokeArgsメソッドは、ReflectionFunctionクラスのインスタンスが表す関数を、指定された引数を用いて動的に実行するメソッドです。

このメソッドは、引数を個別の値として渡すReflectionFunction::invoke()メソッドとは異なり、全ての引数をひとつの配列としてまとめて渡す点が特徴です。具体的には、$reflectionFunction->invokeArgs([$arg1, $arg2, ...])のように、呼び出したい関数の引数の値を順番に格納した配列を一つだけ引数として渡します。これにより、呼び出す関数の引数の数が事前にわからない場合や、引数のリストをプログラムで動的に生成する必要がある場合に、柔軟に関数を実行できます。

関数が正常に実行された場合、その関数の戻り値がそのままinvokeArgsメソッドの戻り値として返されます。もし、実行された関数内で例外（エラー）が発生した場合は、その例外はinvokeArgsメソッドを呼び出した元のコードにそのまま伝播（スロー）されます。そのため、呼び出し側では適切な例外処理を行う必要があります。

この機能は、特にフレームワークやライブラリの開発において、実行時に呼び出すべき関数とその引数を柔軟に制御したい場面で活用されます。例えば、ユーザーが定義したコールバック関数やイベントハンドラを、プログラムの実行中に動的に呼び出す際に非常に有効な手段となります。

Copy
1<?php
2
3function greet(string $name, string $greeting_word): string
4{
5    return "$greeting_word, $name!";
6}
7
8$reflectionFunction = new ReflectionFunction('greet');
9$arguments = ['Alice', 'Hello'];
10$result = $reflectionFunction->invokeArgs($arguments);
11
12// $result には "Hello, Alice!" が格納される
13?>

array $args

• array $args: 呼び出す関数に渡す引数の配列

mixed

指定された関数・メソッド・プロパティ・定数の戻り値（return type）の説明は以下の通りです。

ReflectionFunction::invokeArgsは、ReflectionFunction::invoke()と同様に、リフレクションされた関数を実行した結果を返します。この結果は、実行された関数の定義に依存し、PHPの型システムで表現できるあらゆる型（mixed）になり得ます。