PHPのget_declared_interfaces()関数の使い方を徹底解説

PHPのget_declared_interfaces()関数は、現在のスクリプトで宣言されているすべてのインターフェース名を配列として返す組み込み関数です。標準ライブラリ（SPL）や拡張モジュールによって定義されたインターフェースも含まれるため、デバッグや環境確認に役立ちます。

構文

get_declared_interfaces(void)

パラメータ

• void − この関数は引数を受け取りません。パラメータは不要です。

戻り値

宣言済みのすべてのインターフェース名を格納した配列（Array）を返します。配列の各要素には、Traversable や Iterator など、PHPコアおよび拡張機能で定義されたインターフェースが含まれます。

使用例

以下は get_declared_interfaces() 関数を使用した具体的な例です。

<?php
print_r(get_declared_interfaces());
?>

出力結果

上記のコードを実行すると、次のような出力が得られます（環境やPHPバージョンにより内容は異なる場合があります）。

Array (
    [0] => Traversable
    [1] => IteratorAggregate
    [2] => Iterator
    [3] => ArrayAccess
    [4] => Serializable
    [5] => Throwable
    [6] => DateTimeInterface
    [7] => Reflector
    [8] => RecursiveIterator
    [9] => OuterIterator
    [10] => Countable
    [11] => SeekableIterator
    [12] => SplObserver
    [13] => SplSubject
    [14] => SessionHandlerInterface
    [15] => SessionIdInterface
    [16] => SessionUpdateTimestampHandlerInterface
    [17] => JsonSerializable
)

補足ポイント

• 返される配列には、ユーザーが定義したインターフェースも含まれます。つまり、スクリプト内で interface キーワードを使って宣言したインターフェースもこの一覧に追加されます。

• 類似の関数として、宣言済みクラスの一覧を取得する get_declared_classes() や、宣言済みトレイトの一覧を取得する get_declared_traits() があります。

• 実行環境にインストールされている拡張モジュールによって結果が変わるため、本番環境と開発環境での差異を確認する際にも便利です。