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

Copy
1<?php
2
3/**
4 * 静的メソッドを持つシンプルなクラスの例。
5 * システムの共通処理やユーティリティ関数をまとめる際によく使われます。
6 */
7class MyLogger
8{
9    /**
10     * これは静的メソッドです。
11     * インスタンスを作成せずに `MyLogger::log()` のように直接クラス名から呼び出せます。
12     *
13     * @param string $message ログに記録するメッセージ
14     * @return void
15     */
16    public static function log(string $message): void
17    {
18        echo "[" . date('Y-m-d H:i:s') . "] LOG: " . $message . "\n";
19    }
20
21    /**
22     * これはインスタンスメソッドです。
23     * このメソッドを呼び出すには、まず `(new MyLogger())` のようにクラスのインスタンスを作成する必要があります。
24     * is_callable で静的に参照した場合、true が返ることもありますが、実際に静的に呼び出すとエラーになる点に注意が必要です。
25     *
26     * @return string
27     */
28    public function getUniqueId(): string
29    {
30        return "インスタンスID: " . spl_object_hash($this);
31    }
32}
33
34echo "--- PHPの `is_callable` 関数による静的メソッドの呼び出し可能性チェック ---\n\n";
35
36// 1. 静的メソッドを配列形式で指定してチェックします。
37//    `MyLogger::class` は PHP 5.5 以降で推奨される、クラス名を文字列として取得する方法です。
38$staticMethodRef1 = [MyLogger::class, 'log'];
39$callableName1 = null; // is_callable が認識した呼び出し可能な名前を格納する変数
40
41echo "■ チェック対象: ['MyLogger', 'log'] (配列形式の静的メソッド参照)\n";
42if (is_callable($staticMethodRef1, false, $callableName1)) {
43    echo "  → 結果: 呼び出し可能です。\n";
44    echo "  → is_callableが認識した名前: " . $callableName1 . "\n";
45    // 実際に静的メソッドを呼び出す例 (call_user_func関数を使用)
46    echo "  → 実行結果: ";
47    call_user_func($staticMethodRef1, "配列形式でMyLogger::logが呼び出されました。");
48} else {
49    echo "  → 結果: 呼び出し可能ではありません。\n";
50}
51echo "\n";
52
53// 2. 静的メソッドを文字列形式で指定してチェックします。
54//    'ClassName::methodName' の形式です。
55$staticMethodRef2 = 'MyLogger::log';
56$callableName2 = null;
57
58echo "■ チェック対象: 'MyLogger::log' (文字列形式の静的メソッド参照)\n";
59if (is_callable($staticMethodRef2, false, $callableName2)) {
60    echo "  → 結果: 呼び出し可能です。\n";
61    echo "  → is_callableが認識した名前: " . $callableName2 . "\n";
62    // 実際に静的メソッドを呼び出す例
63    echo "  → 実行結果: ";
64    call_user_func($staticMethodRef2, "文字列形式でMyLogger::logが呼び出されました。");
65} else {
66    echo "  → 結果: 呼び出し可能ではありません。\n";
67}
68echo "\n";
69
70// 3. 存在しない静的メソッドを指定してチェックします。
71$nonExistentMethodRef = [MyLogger::class, 'nonExistentMethod'];
72$callableName3 = null;
73
74echo "■ チェック対象: ['MyLogger', 'nonExistentMethod'] (存在しないメソッド)\n";
75if (is_callable($nonExistentMethodRef, false, $callableName3)) {
76    echo "  → 結果: 呼び出し可能です。\n";
77    echo "  → is_callableが認識した名前: " . $callableName3 . "\n";
78} else {
79    echo "  → 結果: 呼び出し可能ではありません。\n";
80}
81echo "\n";
82
83// 4. `syntax_only` 引数を `true` にしてチェックします。
84//    この引数が `true` の場合、is_callable は実際にそのクラスやメソッドが存在するかどうかをチェックせず、
85//    与えられた値が「構文的に呼び出し可能に見えるか」のみを判断します。
86//    そのため、存在しないクラスやメソッドであっても true を返すことがあります。
87$syntaxOnlyRef = 'NonExistentClass::anyMethod';
88$callableName4 = null;
89
90echo "■ チェック対象: 'NonExistentClass::anyMethod' (syntax_only=true)\n";
91if (is_callable($syntaxOnlyRef, true, $callableName4)) {
92    echo "  → 結果: 構文上は呼び出し可能です。\n"; // クラスやメソッドが存在しなくてもtrueになることがある
93    echo "  → is_callableが認識した名前: " . $callableName4 . "\n";
94    echo "    (注意: syntax_only=true のため、実際には存在しない可能性もあります。)\n";
95} else {
96    echo "  → 結果: 構文上呼び出し可能ではありません。\n";
97}
98echo "\n";
99
100// 補足: インスタンスメソッドを静的に参照した場合の is_callable の挙動
101// is_callable は、与えられた形式が「呼び出し可能である」という構文上の可能性を見るため、
102// インスタンスメソッドであっても 'ClassName::methodName' という形式では true を返すことがあります。
103// しかし、実際に静的に呼び出そうとするとエラーになることがほとんどです。
104$instanceMethodStaticRef = 'MyLogger::getUniqueId';
105$callableName5 = null;
106
107echo "■ チェック対象: 'MyLogger::getUniqueId' (インスタンスメソッドを静的に参照)\n";
108if (is_callable($instanceMethodStaticRef, false, $callableName5)) {
109    echo "  → 結果: 呼び出し可能です (is_callableは構文上可能と判断)。\n";
110    echo "  → is_callableが認識した名前: " . $callableName5 . "\n";
111    echo "    (注意: このメソッドはインスタンスメソッドなので、実際に静的に呼び出すとエラーになります。)\n";
112    // 例: call_user_func($instanceMethodStaticRef); // Fatal error: Uncaught Error: Call to private method MyLogger::getUniqueId() from non-static context
113} else {
114    echo "  → 結果: 呼び出し可能ではありません。\n";
115}
116echo "\n";

PHPのis_callable関数は、指定された値が呼び出し可能であるかを真偽値で判断します。これにより、関数やメソッドを実際に実行する前に、その存在や形式が正しいかを確認できます。

この関数は主に3つの引数を取ります。最初の$valueにはチェックしたい対象を渡し、例えばMyLogger::logのような静的メソッドは、['MyLogger', 'log']という配列形式や、'MyLogger::log'という文字列形式で指定可能です。is_callableはこれらの形式を認識し、指定された静的メソッドが呼び出し可能であればtrueを返します。

2つ目の$syntax_only引数をtrueに設定すると、is_callableは実際にそのメソッドやクラスが存在するかどうかは確認せず、構文上「呼び出し可能に見えるか」だけをチェックします。そのため、存在しないクラスやメソッドであってもtrueを返す場合があります。

3つ目の&$callable_name引数には、呼び出し可能と判断された場合にis_callableが認識した完全な名前が文字列として格納されます。

注意点として、MyLogger::getUniqueIdのようにインスタンスメソッドを静的に参照する形式で指定した場合、is_callableは構文上呼び出し可能と判断してtrueを返すことがありますが、実際に静的に呼び出そうとするとエラーになるため注意が必要です。この関数は、動的な処理を安全に実装するために役立ちます。

Copy
1<?php
2
3/**
4 * is_callable と method_exists の違いを示すサンプルコード。
5 */
6
7class MyClass {
8    public function myMethod() {
9        return true;
10    }
11}
12
13$obj = new MyClass();
14
15// 文字列でメソッド名を指定
16$methodName = 'myMethod';
17
18// method_exists は、クラスにメソッドが存在するかどうかをチェックする
19if (method_exists($obj, $methodName)) {
20    echo "method_exists: MyClass に myMethod は存在します。\n";
21} else {
22    echo "method_exists: MyClass に myMethod は存在しません。\n";
23}
24
25// is_callable は、コールバックとして呼び出し可能かどうかをチェックする
26// コールバックは、関数名を表す文字列、メソッド名を表す配列、または Closure オブジェクトのいずれか
27if (is_callable([$obj, $methodName])) {
28    echo "is_callable: \$obj->myMethod は呼び出し可能です。\n";
29} else {
30    echo "is_callable: \$obj->myMethod は呼び出し可能ではありません。\n";
31}
32
33// 文字列のみの場合の挙動の違い
34$nonExistentMethod = 'nonExistentMethod';
35
36if (!method_exists($obj, $nonExistentMethod)) {
37    echo "method_exists: MyClass に nonExistentMethod は存在しません。\n";
38} else {
39    echo "method_exists: MyClass に nonExistentMethod は存在します。\n";
40}
41
42if (!is_callable([$obj, $nonExistentMethod])) {
43    echo "is_callable: \$obj->nonExistentMethod は呼び出し可能ではありません。\n";
44} else {
45    echo "is_callable: \$obj->nonExistentMethod は呼び出し可能です。\n";
46}
47
48// 関数名の場合
49function myFunction() {
50    return true;
51}
52
53if (is_callable('myFunction')) {
54    echo "is_callable: myFunction は呼び出し可能です。\n";
55} else {
56    echo "is_callable: myFunction は呼び出し可能ではありません。\n";
57}

is_callable関数は、PHPの組み込み関数で、指定された変数がコールバックとして呼び出し可能かどうかを判定します。PHP8で利用可能です。引数 $value には、判定したい変数を指定します。オプションの引数 $syntax_only は、構文チェックのみを行うかを指定するbool値で、デフォルトは false です。$callable_name には、呼び出し可能な名前が文字列で返されます。戻り値は、呼び出し可能であれば true、そうでなければ false を返します。

このサンプルコードでは、is_callable と method_exists の違いを示しています。method_exists は、クラス内に指定された名前のメソッドが存在するかどうかをチェックするのに対し、is_callable は、変数が関数として呼び出し可能かどうかをチェックします。例えば、存在しないメソッド名を指定した場合、method_exists は false を返しますが、is_callable は配列 [$obj, 'nonExistentMethod'] の形式で、メソッドとして呼び出し可能かどうかを判定します。関数名の場合は、is_callable('myFunction') のように文字列で指定することで、その関数が定義されているかどうかを確認できます。is_callable は、文字列で関数名が指定された場合にも、グローバル空間にその関数が存在するかどうかを確認できます。この例では、myFunction が定義されているため、is_callable('myFunction') は true を返します。is_callable は、コールバック関数を扱う際に、事前に有効性を確認するために役立ちます。