【PHP8.x】TARGET_METHOD定数の使い方

TARGET_METHOD定数の使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年10月17日

基本的な使い方

TARGET_METHOD定数は、PHP 8で導入された「Attribute（属性）」機能において、その属性が適用できる対象が「メソッド」であることを表す定数です。PHP 8のAttribute機能は、クラス、メソッド、プロパティなどのコード要素に対して、追加の構造化された情報（メタデータ）をプログラム的に付与するための強力な仕組みです。これにより、例えばフレームワークが特定のメソッドの挙動をカスタマイズしたり、ドキュメント生成ツールがメソッドの情報を効率的に抽出したりするといったことが可能になります。

このTARGET_METHOD定数は、開発者がカスタムのAttributeを定義する際に非常に重要です。Attributeを定義するクラスには、#[Attribute]という組み込みのAttributeを付与し、その引数としてAttribute::TARGET_METHODを指定することができます。これは、#[Attribute(Attribute::TARGET_METHOD)]のように記述され、「このAttributeは、クラス内のメソッドに対してのみ適用可能です」という明確な制約を設定します。例えば、#[Route('/users')]のようなAttributeを作成し、これをメソッドにのみ適用させたい場合に利用します。

もし、TARGET_METHODを指定したAttributeが、誤ってクラスやプロパティなどの別のコード要素に適用されようとすると、PHPは実行時にエラーを発生させ、開発者に正しい使用方法を強制します。このように、TARGET_METHOD定数を含む各種のターゲット定数（TARGET_CLASS、TARGET_PROPERTYなど）は、Attributeの適用範囲を厳密に制御し、コードの意図を明確にするとともに、不適切な利用を防ぐことで、コードの堅牢性と保守性を大きく向上させる役割を担っています。

構文(syntax)


1<?php
2
3use Attribute;
4
5#[Attribute(Attribute::TARGET_METHOD)]
6class MyCustomMethodAttribute
7{
8    // この属性はメソッドにのみ適用可能です
9}

引数(parameters)

戻り値(return)

int

Attribute::TARGET_METHOD は、メソッドに適用される属性であることを示す整数定数です。

サンプルコード

PHP Attribute TARGET_METHOD でメソッド属性を適用する


1<?php
2
3/**
4 * メソッドにのみ適用可能な属性の例
5 */
6#[Attribute(Attribute::TARGET_METHOD)]
7class MyAttribute
8{
9    public function __construct(public string $message)
10    {
11    }
12}
13
14class MyClass
15{
16    /**
17     * MyAttribute が適用されたメソッド
18     */
19    #[MyAttribute("Hello from MyAttribute!")]
20    public function myMethod(): void
21    {
22        echo "myMethod called.\n";
23        $reflection = new ReflectionMethod($this, 'myMethod');
24        $attributes = $reflection->getAttributes(MyAttribute::class);
25
26        foreach ($attributes as $attribute) {
27            $instance = $attribute->newInstance();
28            echo $instance->message . "\n";
29        }
30    }
31
32    // プロパティに適用しようとするとエラーになる (PHP8以降)
33    // #[MyAttribute("This will cause an error")]
34    // public string $myProperty;
35}
36
37$obj = new MyClass();
38$obj->myMethod();
39
40?>

このPHPのサンプルコードは、属性（Attribute）をメソッドに適用する方法を示しています。Attribute::TARGET_METHODは、属性をメソッドにのみ適用可能にするための定数です。

まず、#[Attribute(Attribute::TARGET_METHOD)]で定義されたMyAttributeクラスは、属性として機能し、$messageという文字列型のプロパティを持ちます。この属性は、コンストラクタでメッセージを受け取ります。Attribute::TARGET_METHODを指定することで、この属性はメソッドに対してのみ使用可能となります。

次に、MyClassクラスでは、myMethodというメソッドに#[MyAttribute("Hello from MyAttribute!")]としてMyAttribute属性が適用されています。この属性によって、myMethodが呼び出される際に、MyAttributeのインスタンスが生成され、メッセージが出力されます。

ReflectionMethodクラスを使用すると、メソッドに関する情報を取得できます。ここでは、getAttributes()メソッドを使ってMyAttribute属性の情報を取得し、そのインスタンスからメッセージを取り出しています。

サンプルコードでは、MyClassのインスタンスを作成し、myMethod()を呼び出すことで、属性が適用されたメソッドが実行される様子を示しています。属性に渡されたメッセージがコンソールに出力されることが確認できます。

コメントアウトされている$myPropertyの箇所は、プロパティにMyAttribute属性を適用しようとするとエラーが発生することを示唆しています。これは、Attribute::TARGET_METHODが指定されているため、属性がメソッドにのみ適用可能であるからです。この機能により、属性の適用範囲を限定し、コードの意図を明確にすることができます。

Attribute::TARGET_METHODは、PHP8以降で使用できる属性（Attribute）のターゲットを指定する定数です。この定数を指定すると、属性はメソッドに対してのみ適用可能になります。サンプルコードでは、MyAttributeクラスがAttribute::TARGET_METHODで定義されているため、myMethodには適用できますが、myPropertyのようなプロパティには適用できません。プロパティに適用しようとすると、PHPはエラーを発生させます。属性を定義する際は、適用対象を明確にし、TARGET_METHODを適切に使用することで、意図しない属性の適用を防ぐことができます。また、リフレクションAPIを利用して、メソッドに付与された属性の情報を取得し、実行時に利用できる点も重要です。