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

Copy
1<?php
2
3/**
4 * function_exists 関数の使用例
5 * 指定された関数が存在するかどうかを確認します。
6 */
7
8// 組み込み関数が存在するか確認
9if (function_exists('array_push')) {
10    echo "array_push 関数は存在します。\n";
11} else {
12    echo "array_push 関数は存在しません。\n";
13}
14
15// ユーザー定義関数が存在するか確認
16function my_custom_function() {
17    echo "これはカスタム関数です。\n";
18}
19
20if (function_exists('my_custom_function')) {
21    echo "my_custom_function 関数は存在します。\n";
22    my_custom_function(); // 関数を実行
23} else {
24    echo "my_custom_function 関数は存在しません。\n";
25}
26
27// 存在しない関数を確認
28if (function_exists('non_existent_function')) {
29    echo "non_existent_function 関数は存在します。\n";
30} else {
31    echo "non_existent_function 関数は存在しません。\n";
32}
33
34?>

PHPのfunction_exists関数は、指定された名前の関数が定義されているかどうかを調べるために使用します。引数には、確認したい関数名を文字列で渡します。この関数は、組み込み関数とユーザー定義関数の両方を確認できます。

サンプルコードでは、まずarray_pushという組み込み関数が存在するかどうかをfunction_exists関数で確認しています。array_pushはPHPに標準で備わっている関数なので、存在する場合は「array_push 関数は存在します。」というメッセージが表示されます。

次に、my_custom_functionというユーザー定義関数を定義し、同様にfunction_exists関数でその存在を確認しています。関数が存在する場合は、「my_custom_function 関数は存在します。」というメッセージが表示され、その後、実際にmy_custom_function関数が実行されます。

最後に、non_existent_functionという存在しない関数をfunction_exists関数で確認しています。この関数は定義されていないため、「non_existent_function 関数は存在しません。」というメッセージが表示されます。

function_exists関数は、関数が存在するかどうかを示す真偽値（trueまたはfalse）を返します。関数の存在を確認することで、存在しない関数を呼び出してエラーが発生するのを防ぎ、プログラムの安定性を高めることができます。関数の有無によって処理を分岐させたい場合に役立ちます。

Copy
1<?php
2
3/**
4 * テスト用のグローバル関数を定義します。
5 * function_exists がこの関数の存在をチェックするために使用されます。
6 */
7function myTestGlobalFunction(): string
8{
9    return "これは 'myTestGlobalFunction' です。";
10}
11
12/**
13 * グローバル関数が存在するかどうかをオブジェクトのコンテキスト内でチェックするクラスです。
14 *
15 * function_exists 関数は、PHPのグローバルな関数（スクリプトのどこからでも呼び出せる関数）が
16 * 定義されているかどうかを確認するために使用されます。
17 * クラスのメソッドやオブジェクトのメソッドの存在をチェックするものではありません。
18 */
19class GlobalFunctionChecker
20{
21    /**
22     * このメソッド内で function_exists を使用して、グローバル関数の存在をチェックします。
23     * これは、オブジェクトの内部からグローバルな状態（この場合はグローバル関数の存在）
24     * を確認する例を示しています。
25     */
26    public function checkFunctions(): void
27    {
28        echo "--- グローバル関数の存在チェック ---\n";
29
30        // 存在するグローバル関数をチェックする例
31        if (function_exists('myTestGlobalFunction')) {
32            echo "  'myTestGlobalFunction' は存在します。\n";
33            echo "  呼び出し結果: " . myTestGlobalFunction() . "\n";
34        } else {
35            echo "  'myTestGlobalFunction' は存在しません。\n";
36        }
37
38        echo "\n";
39
40        // 存在しないグローバル関数をチェックする例
41        if (function_exists('nonExistentFunction')) {
42            echo "  'nonExistentFunction' は存在します。\n";
43        } else {
44            echo "  'nonExistentFunction' は存在しません。\n";
45        }
46
47        echo "\n";
48
49        echo "--- 注意: function_exists はクラスのメソッドをチェックしません ---\n";
50        // 重要: function_exists はクラスのメソッドの存在はチェックしません。
51        // クラスのメソッドの存在を確認するには method_exists 関数を使用します。
52        // そのため、以下のチェックは常に false を返します。
53        if (function_exists('GlobalFunctionChecker::checkFunctions')) {
54            echo "  'GlobalFunctionChecker::checkFunctions' が存在すると誤って判断されました (function_exists の誤用)。\n";
55        } else {
56            echo "  'GlobalFunctionChecker::checkFunctions' は存在しません (これは正しい結果です)。\n";
57        }
58    }
59}
60
61// GlobalFunctionChecker クラスのインスタンス（オブジェクト）を作成します。
62$checker = new GlobalFunctionChecker();
63
64// オブジェクトのメソッドを呼び出し、グローバル関数の存在をチェックします。
65// これにより、「オブジェクト内」から function_exists が実行される例となります。
66$checker->checkFunctions();
67
68?>

このサンプルコードは、PHPのfunction_exists関数を使って、グローバル関数が存在するかどうかをオブジェクトのコンテキスト内で確認する方法を示しています。function_exists関数は、引数に指定された名前の関数が定義済みかどうかを調べ、真偽値(true/false)を返します。

最初に、myTestGlobalFunctionというグローバル関数を定義しています。これは、function_existsで存在を確認するための関数です。

次に、GlobalFunctionCheckerというクラスを定義し、その中にcheckFunctionsというメソッドを作成しています。このメソッド内でfunction_existsを使い、myTestGlobalFunctionとnonExistentFunctionという存在しない関数の存在をチェックしています。存在すればメッセージを表示し、関数を呼び出します。存在しなければ、存在しない旨を表示します。

重要な点として、function_existsはクラスのメソッドの存在は確認できません。GlobalFunctionChecker::checkFunctionsのようにクラス名とメソッド名を指定しても、常にfalseを返します。クラスのメソッドの存在を確認するには、method_exists関数を使用する必要があります。

最後に、GlobalFunctionCheckerクラスのインスタンスを作成し、checkFunctionsメソッドを呼び出しています。これにより、オブジェクトの内部からグローバルな関数の存在を確認する例を示しています。

Copy
1<?php
2
3// --- グローバル名前空間の定義 ---
4
5/**
6 * グローバル名前空間に定義されたサンプル関数です。
7 * function_exists 関数による存在チェックの対象となります。
8 */
9function globalSampleFunction(): void
10{
11    // この関数はデモ内で呼び出されません。
12}
13
14// --- MyProject 名前空間の定義 ---
15
16namespace MyProject; // ここから MyProject 名前空間に入ります
17
18/**
19 * MyProject 名前空間内に定義されたサンプル関数です。
20 * function_exists 関数による存在チェックの対象となります。
21 */
22function namespacedSampleFunction(): void
23{
24    // この関数はデモ内で呼び出されません。
25}
26
27/**
28 * PHPの function_exists 関数と名前空間の挙動を示すデモンストレーション関数です。
29 * システムエンジニアを目指す初心者向けに、関数の存在チェック方法と
30 * 名前空間がそれにどう影響するかを解説します。
31 */
32function demonstrateFunctionExists(): void
33{
34    echo "--- function_exists と名前空間のデモ ---\n\n";
35
36    // 1. グローバル名前空間の関数の存在チェック
37    // 名前空間内にいても、グローバル関数は直接名前でチェックできます。
38    if (function_exists('globalSampleFunction')) {
39        echo "1. 'globalSampleFunction' (グローバル空間) は存在します。\n\n";
40    } else {
41        echo "1. 'globalSampleFunction' (グローバル空間) は存在しません。\n\n";
42    }
43
44    // 2. PHP組み込み関数の存在チェック (常にグローバル名前空間に存在します)
45    if (function_exists('array_map')) {
46        echo "2. 'array_map' (組み込み関数) は存在します。\n\n";
47    } else {
48        echo "2. 'array_map' (組み込み関数) は存在しません。\n\n";
49    }
50
51    // 3. 現在の名前空間 (MyProject) 内の関数の存在チェック
52    // 名前空間内の関数を正確にチェックするには、完全修飾名 (FQCN) を使用する必要があります。
53    // __NAMESPACE__ 定数は現在の名前空間名を返します。
54    $fullyQualifiedName = __NAMESPACE__ . '\\namespacedSampleFunction';
55    if (function_exists($fullyQualifiedName)) {
56        echo "3. '{$fullyQualifiedName}' (名前空間内) は存在します。\n\n";
57    } else {
58        echo "3. '{$fullyQualifiedName}' (名前空間内) は存在しません。\n\n";
59    }
60
61    // 4. 不完全な名前で名前空間内の関数をチェックした場合
62    // function_exists('namespacedSampleFunction') は、現在の名前空間内ではなく、
63    // グローバル名前空間の 'namespacedSampleFunction' を探します。
64    echo "4. 'namespacedSampleFunction' (不完全な名前) でチェック:\n";
65    if (function_exists('namespacedSampleFunction')) {
66        echo "   存在します。(注: グローバル空間に同名の関数があればtrue、なければfalse)\n\n";
67    } else {
68        echo "   存在しません。(注: グローバル空間に同名の関数があればtrue、なければfalse)\n\n";
69    }
70
71    // 5. 存在しない関数のチェック
72    if (function_exists('nonExistentFunction')) {
73        echo "5. 'nonExistentFunction' は存在します。(このメッセージは通常表示されません)\n\n";
74    } else {
75        echo "5. 'nonExistentFunction' は存在しません。\n\n";
76    }
77}
78
79// デモンストレーション関数を実行します。
80// この関数は MyProject 名前空間内で定義されているため、
81// MyProject\demonstrateFunctionExists として解決され実行されます。
82demonstrateFunctionExists();
83
84?>

function_exists関数は、引数に指定された関数名（文字列）がPHPで定義されているかを確認し、存在すればtrue、なければfalseを返します。

この関数は、PHPの名前空間と組み合わせる際、その挙動を理解しておくことが重要です。globalSampleFunctionのようなグローバル関数やarray_mapのような組み込み関数は、現在の名前空間に関わらず、関数名を直接指定して存在チェックが可能です。

一方、名前空間内で定義された関数をチェックする場合は注意が必要です。不完全な関数名で指定すると、function_existsはグローバル名前空間を探します。そのため、名前空間内の関数を正確にチェックするには、MyProject\namespacedSampleFunctionのように完全修飾名（FQCN）を引数に指定する必要があります。これにより、目的の関数が指定の名前空間内に確実に存在するかを判断できます。存在しない関数名を指定した場合はfalseが返されます。

Copy
1<?php
2
3/**
4 * 指定された関数が定義済みかどうかを確認する例.
5 *
6 * @return void
7 */
8function checkFunctionExists(): void
9{
10    $functionName = 'array_map';
11
12    if (function_exists($functionName)) {
13        echo "関数 '$functionName' は定義されています。\n";
14    } else {
15        echo "関数 '$functionName' は定義されていません。\n";
16    }
17
18    $undefinedFunctionName = 'undefined_function';
19
20    if (function_exists($undefinedFunctionName)) {
21        echo "関数 '$undefinedFunctionName' は定義されています。\n";
22    } else {
23        echo "関数 '$undefinedFunctionName' は定義されていません。\n";
24    }
25}
26
27checkFunctionExists();

このPHPのサンプルコードは、function_exists関数を使って、指定された関数が定義済みかどうかをチェックする方法を示しています。function_exists関数は、引数として関数の名前（文字列）を受け取り、その関数が現在の環境で利用可能かどうかをboolean値（trueまたはfalse）で返します。

サンプルコードでは、まずcheckFunctionExistsという関数を定義しています。この関数内で、array_mapというPHPの組み込み関数と、undefined_functionという存在しない関数を例として取り上げ、function_exists関数を使ってそれぞれの存在を確認しています。

array_mapはPHPに標準で備わっている関数なので、function_exists('array_map')はtrueを返し、「関数 'array_map' は定義されています。」と出力されます。一方、undefined_functionは定義されていないため、function_exists('undefined_function')はfalseを返し、「関数 'undefined_function' は定義されていません。」と出力されます。

このコードを実行することで、function_exists関数が、関数名に対応する関数が定義されているかどうかを正しく判定できることがわかります。システムエンジニアを目指す上で、この関数は、外部ライブラリや拡張機能の利用可否を事前に確認し、エラーを未然に防ぐために役立ちます。例えば、特定の関数が存在する場合のみ、その関数を利用した処理を実行するように制御することができます。