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

<?php

/**
 * call_user_func の使用例：シンプルな関数呼び出し.
 */
function greet(string $name): string
{
    return "Hello, " . $name . "!";
}

$message = call_user_func('greet', 'World');
echo $message . PHP_EOL; // 出力: Hello, World!

/**
 * call_user_func の使用例：クラスのメソッド呼び出し.
 */
class Greeter
{
    public function greet(string $name): string
    {
        return "Greetings, " . $name . "!";
    }
}

$greeter = new Greeter();
$message = call_user_func([$greeter, 'greet'], 'User');
echo $message . PHP_EOL; // 出力: Greetings, User!

/**
 * call_user_func の使用例：クロージャの呼び出し.
 */
$multiplier = function (int $x, int $y): int {
    return $x * $y;
};

$product = call_user_func($multiplier, 5, 3);
echo $product . PHP_EOL; // 出力: 15

/**
 * call_user_func の使用例：静的メソッドの呼び出し.
 */
class Calculator
{
    public static function add(int $a, int $b): int
    {
        return $a + $b;
    }
}

$sum = call_user_func([Calculator::class, 'add'], 10, 20);
echo $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 は警告またはエラーを発生させることがあります。

<?php

/**
 * コールバック関数を使用して、文字列を大文字に変換する。
 *
 * @param string $string 変換する文字列
 * @return string 大文字に変換された文字列
 */
function toUpper(string $string): string
{
  return strtoupper($string);
}

/**
 * コールバック関数を使用して、文字列を指定回数繰り返す。
 *
 * @param string $string 繰り返す文字列
 * @param int $times 繰り返す回数
 * @return string 繰り返された文字列
 */
function repeatString(string $string, int $times): string
{
  return str_repeat($string, $times);
}

// コールバック関数と引数
$callback1 = 'toUpper';
$argument1 = 'hello';

$callback2 = 'repeatString';
$argument2 = 'world';
$times = 3;

// call_user_func を使用してコールバック関数を実行
$result1 = call_user_func($callback1, $argument1);
$result2 = call_user_func($callback2, $argument2, $times);

// 結果を表示
echo "Result 1: " . $result1 . PHP_EOL; // 出力: HELLO
echo "Result 2: " . $result2 . PHP_EOL; // 出力: worldworldworld

// クロージャ（無名関数）を使用する場合
$callback3 = function (string $name) {
    return "Hello, " . $name . "!";
};

$result3 = call_user_func($callback3, "Alice");

echo "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を使うことで、実行時にどの関数を実行するかを決定できます。戻り値は、コールバック関数の戻り値がそのまま返されます。