Callable

PHPの要素で関数として呼び出すことができるものをコールバックまたは callable といいます。

本記事のタイトルにもあるとおり、コールバック関数といわれることもあるようです（実際 PHP マニュアルにも書かれています）。

無用な混乱をさけるため、本記事では呼び方を callable で統一することにします。

Examples

説明を読んだだけでは理解できないと思いますので、callable の例をたくさんみていくことにしましょう。

例１

PHP

function hello() {
    echo 'こんにちは。';
}

echo is_callable('hello') . PHP_EOL;

call_user_func('hello');

result

1
こんにちは。

５行目のis_callableは、引数が callable であるかどうかを調べてくれる関数です。

is_callable — 引数が、関数としてコール可能な構造であるかどうかを調べる

PHP: is_callable - Manual

引数が callable ならtrueを、そうでなければfalseを返します。
また、echo trueは1を出力しecho falseは何も出力しません。

上記の例では1が出力されていますので、is_callbleの引数である文字列helloは callable であることがわかりました。
callable であるということは、文字列helloを関数として呼び出せるということです。

実際に、７行目でcall_user_funcという関数をつかって callable である文字列helloを関数として呼び出しています。

call_user_func — 最初の引数で指定したコールバック関数をコールする

PHP: call_user_func - Manual

こんにちは。と出力されていますので、１〜３行目で定義されている関数helloが呼び出されたことがわかりますね。

一般に、関数fooが定義されているとき文字列fooは callable となります。
このとき文字列fooをcall_user_funcにわたすことによって、関数fooを呼び出すことができます。

例２

PHP

function hello() {
    echo 'こんにちは。';
}

echo is_callable(hello) . PHP_EOL;

call_user_func(hello);

PHP Warning:  Use of undefined constant hello - assumed 'hello' (this will throw an Error in a future version of PHP) in ...
PHP Warning:  Use of undefined constant hello - assumed 'hello' (this will throw an Error in a future version of PHP) in ...

今回はエラーが出てしまいました。

エラーメッセージをよく読むとUse of undefined constant hello - assumed 'hello'と書かれています。
これは「定義されていない定数helloをつかっているようだけど、それは文字列helloのことじゃないか？」という意味です。

例１の５行目と７行目では、helloを二つのシングルクォーテーション（''）でかこむことによって、それが文字列であることを表していました。

今回の例では、シングルクォーテーションでかこむことをしなかったため、helloは定数として解釈されます。
このとき PHP は定数helloの値を関数にわたそうとします。
ところが定数helloは定義されていませんので、PHP はたいへん狼狽し、エラーメッセージを吐き、森へ帰ってしまったというわけです（？）。

PHP 関数はその名前を単に文字列として渡します。

PHP: コールバック / Callable - Manual

例３

PHP

function sum($int1, $int2) {
    return $int1 + $int2;
}

echo is_callable('sum') . PHP_EOL;

echo call_user_func_array('sum', [2, 5]);

result

1
7

１〜３行目で定義されている関数sumは、二つの数値をうけとって、それらの和を返すというものです。
これを実行するためにはsum(2, 5)のように二つの引数を指定する必要があります。

このような場合でも、文字列sum自体は callable です。
これは５行目の命令によって1が出力されていることからわかります。

さて、文字列sumが callable だということは、文字列sumを関数として呼び出せるということです。
sumのような引数を必要とする関数を callable によって呼び出したいときは、call_user_func_arrayという関数をつかいます。

call_user_func_array — パラメータの配列を指定してコールバック関数をコールする

PHP: call_user_func_array - Manual

第一引数には callable を、第二引数には呼び出される関数にわたしたい式を配列にしたものを指定します。

７行目では、call_user_func_arrayの第一引数には callable である文字列sumを、第二引数には配列[2, 5]を指定しました。
これによって関数sumが呼び出され、関数sumの第一引数には2が、第二引数には5がわたされます。
このとき関数sumは2と5の和である7を返しますので、この7がechoされて7が出力されたというわけです。

余談・・

つぎのコードは今回の例の７行目をecho call_user_func('sum');にとりかえたものです。

PHP

function sum($int1, $int2) {
    return $int1 + $int2;
}

echo is_callable('sum') . PHP_EOL;

echo call_user_func('sum');

これを実行すると、もちろんエラーが出るのですが、このときのエラーメッセージはつぎのようになります。

result

PHP Fatal error:  Uncaught ArgumentCountError: Too few arguments to function sum(), 0 passed in ... and exactly 2 expected in ......

「関数sumにわたす引数が少なすぎるよ！」といわれています。
ということは、関数sumの呼び出し自体は問題なく行われたということです。

先ほどみたとおり、文字列sum自体は callable でした。
ですので、call_user_funcの引数に文字列sumを指定してあげれば、関数sumを呼び出すこと自体は問題なくできるというわけです。

例４

PHP

$hello = function () {
  echo 'こんにちは。';  
};

echo is_callable($hello) . PHP_EOL;

call_user_func($hello);

result

1
こんにちは。

１〜３行目で、変数helloに無名関数を代入しています。

無名関数は callable です。
これは５行目の命令によって1が出力されていることからわかります。

一般的なユーザー定義関数とは異なり、無名関数もパラメータとして渡せます。

PHP: コールバック / Callable - Manual

７行目では、call_user_funcに変数helloの値である無名関数をわたすことによって、その無名関数自身を呼び出しています。

ちなみに・・

PHP

$hello = function () {
  echo 'こんにちは。';  
};

var_dump($hello);

result

object(Closure)#1 (0) {
}

無名関数はPHPが用意しているClosureという特別なクラスのインスタンスとして実現されています。

無名関数の実装には Closure クラスを使っています。

PHP: 無名関数 - Manual

例５

PHP

class Player {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getname() {
        return $this->name;
    }
}

$ichiro = new Player('イチロー');

echo is_callable([$ichiro, 'getname']) . PHP_EOL;

echo call_user_func([$ichiro, 'getname']);

result

1
イチロー

１〜１０行目で、Playerクラスを定義しています。このクラスのなかでgetnameというメソッドを定義しました。
つづく１２行目でPlayerクラスのインスタンスを作成し、変数ichiroに代入しています。

このとき、配列[$ichiro, 'getname']は callable です。
この配列をcall_user_funcの引数に指定することで、変数ichiroに代入されたPlayerクラスのインスタンスのgetnameメソッドを呼び出すことができます。

オブジェクトのインスタンスを渡すには配列を使います。配列の 0 番目の要素にオブジェクトを、そして 1 番目の要素にメソッド名を指定します。

PHP: コールバック / Callable - Manual

イチローと出力されていることから、所期のメソッドが呼び出されたことがわかりますね。

例６

PHP

class Car {
    public static function honk() {
        echo 'ビッビー';
    }
}

echo is_callable(['Car', 'honk']) . PHP_EOL;

call_user_func(['Car', 'honk']);

result

1
ビッビー

１〜５行目で、Carクラスを定義し、そのなかでhonkという静的メソッドを定義しました。

このとき、配列['Car', 'honk']は callable です。
この配列をcall_user_funcの引数に指定することで、Carクラスの静的メソッドhonkを呼び出すことができます。

静的なクラスメソッドの場合、オブジェクトのインスタンスは不要です。 0 番目の要素として、オブジェクトのかわりにクラス名を指定します。

PHP: コールバック / Callable - Manual

例７

PHP

class Car {
    public static function honk() {
        echo 'ビッビー';
    }
}

echo is_callable('Car::honk') . PHP_EOL;

call_user_func('Car::honk');

result

1
ビッビー

クラスの定義は例６とおなじです。

例６では、配列['Car', 'honk']が callable であることをたしかめました。
今回の例は、文字列Car::honkもまた callable であることを表しています。

'ClassName::methodName' 形式で指定することもできます。

PHP: コールバック / Callable - Manual

クラスの静的メソッドを callable として表現する方法は二種類あるということですね。

おしまい

callable の例をたくさんみてきました。
これで callable とは何なのか、多少なりとも理解が深まったと思います。

また、本記事では説明が不十分な箇所も多々あるかと思います。
疑問に思うところがあったら、適宜 PHP マニュアル等を参照してください。

最後まで読んでいただき、ありがとうございました。

PHPコールバック関数入門

Callable

Examples

例１

例２

例３

例４

例５

例６

例７

おしまい