【PHP8.x】Dom\HTMLElement::getAttributeNS()メソッドの使い方

getAttributeNSメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月22日

基本的な使い方

getAttributeNSメソッドは、指定された名前空間とローカル名を持つ属性の値を取得するメソッドです。このメソッドは、Dom\HTMLElementクラスに属しており、HTML要素ノードから特定の属性値を名前空間を考慮して取得するために使用されます。

具体的には、getAttributeNSメソッドは2つの引数を取ります。1つ目は名前空間URI（Uniform Resource Identifier）を表す文字列、2つ目は取得したい属性のローカル名を表す文字列です。名前空間URIは、属性が属する名前空間を識別するために使用されます。ローカル名は、名前空間内で属性を一意に識別します。

このメソッドは、指定された名前空間とローカル名を持つ属性が存在する場合、その属性の値を文字列として返します。もし、指定された属性が存在しない場合は、空文字列（""）を返します。

getAttributeNSメソッドは、特にXMLや名前空間を扱う場合に有用です。HTML5では、カスタムデータ属性などで名前空間を利用することがあります。このような場合に、getAttributeNSメソッドを利用することで、特定の名前空間に属する属性の値を確実に取得することができます。

getAttributeNSメソッドを使用することで、HTML要素の属性をより柔軟に、かつ正確に扱うことが可能になります。名前空間を意識した属性処理を行う際には、このメソッドの利用を検討してください。このメソッドは、HTMLドキュメント内の要素から特定の属性値を、名前空間を考慮して取得する必要がある場合に適しています。

構文(syntax)


1Dom\HTMLElement::getAttributeNS(string $namespace, string $localName): string|null

引数(parameters)

?string $namespace, string $localName

?string $namespace: 属性が属する名前空間を指定します。名前空間がない場合は null を指定します。
string $localName: 取得したい属性の名前を指定します。

戻り値(return)

?string

指定された名前空間（namespace）で定義された属性の値があれば文字列として返します。属性が存在しない場合は null を返します。

サンプルコード

PHP DOM getAttributeNS で名前空間属性を取得する


1<?php
2
3// HTMLドキュメントの例。SVG要素内にXLink名前空間を持つ属性を含む<a>要素を埋め込みます。
4$htmlContent = <<<'HTML'
5<!DOCTYPE html>
6<html>
7<head>
8    <title>PHP DOM getAttributeNS 例</title>
9</head>
10<body>
11    <h1>SVG要素の名前空間付き属性の取得</h1>
12    <svg width="200" height="200" xmlns="http://www.w3.org/2000/svg">
13        <!-- 'xlink:href' は XLink 名前空間に属する属性です -->
14        <a xlink:href="https://www.php.net" target="_blank" xmlns:xlink="http://www.w3.org/1999/xlink">
15            <circle cx="100" cy="100" r="80" fill="skyblue" />
16        </a>
17    </svg>
18</body>
19</html>
20HTML;
21
22// DOMDocumentオブジェクトを生成
23$dom = new DOMDocument();
24// HTML文字列をDOMDocumentにロード
25$dom->loadHTML($htmlContent);
26
27// SVGの名前空間URIを定数として定義
28const SVG_NAMESPACE_URI = 'http://www.w3.org/2000/svg';
29// XLinkの名前空間URIを定数として定義
30const XLINK_NAMESPACE_URI = 'http://www.w3.org/1999/xlink';
31
32// SVG名前空間内の'a'要素をすべて取得します。
33// getElementsByTagNameNS() は、特定の名前空間に属する要素を検索する際に便利です。
34$svgAElements = $dom->getElementsByTagNameNS(SVG_NAMESPACE_URI, 'a');
35
36if ($svgAElements->length > 0) {
37    // 最初のSVG 'a'要素を取得
38    // Dom\HTMLElement クラスは PHP 8.2 で導入されましたが、
39    // DOMElement クラスは PHP 5 から存在し、getAttributeNS メソッドを持ちます。
40    // Dom\HTMLElement は DOMElement を継承しているため、PHP 8.2 以降では Dom\HTMLElement のインスタンスに対しても同様に動作します。
41    /** @var DOMElement $svgAElement */
42    $svgAElement = $svgAElements->item(0);
43
44    echo "--- SVG <a>要素の属性値の取得 ---" . PHP_EOL;
45
46    // getAttributeNS を使用して、XLink名前空間の 'href' 属性の値を取得します。
47    // 引数1: 属性の名前空間URI ('http://www.w3.org/1999/xlink')
48    // 引数2: 属性のローカル名（プレフィックスを含まない 'href'）
49    // 戻り値: 属性の値 (string) または属性が存在しない場合は null
50    $xlinkHref = $svgAElement->getAttributeNS(XLINK_NAMESPACE_URI, 'href');
51    echo "XLink名前空間の 'href' 属性値: " . ($xlinkHref ?? '取得できませんでした (null)') . PHP_EOL;
52
53    // 名前空間のない通常の 'target' 属性の値を取得します。
54    // 通常の属性は getAttribute() を使用します。
55    $targetAttr = $svgAElement->getAttribute('target');
56    echo "通常の 'target' 属性値: " . ($targetAttr ?? '取得できませんでした (null)') . PHP_EOL;
57
58    // 存在しない名前空間付き属性の取得を試みます。
59    // 存在しない属性の場合、getAttributeNS は null を返します。
60    $nonExistentAttr = $svgAElement->getAttributeNS('http://example.com/non-existent', 'id');
61    echo "存在しない名前空間付き属性の値 (期待値: null): " . ($nonExistentAttr ?? '取得できませんでした (null)') . PHP_EOL;
62
63} else {
64    echo "SVG名前空間内の 'a' 要素が見つかりませんでした。" . PHP_EOL;
65}

PHPのDom\HTMLElementクラス（またはDOMElementクラス）が提供するgetAttributeNSメソッドは、HTMLやXMLドキュメント内で、特定の「名前空間（ネームスペース）」に属する属性の値を取得するために使用します。名前空間は、同じ名前の属性が異なる意味を持つことを区別するために利用され、特にSVGやXMLドキュメントで頻繁に登場します。

このメソッドは2つの引数を取ります。1つ目の$namespaceには、取得したい属性が所属する名前空間のURI（URLのような一意の識別子）を指定します。2つ目の$localNameには、属性のプレフィックスを含まない本来の名前（例えばxlink:href属性であればhref）を指定します。

戻り値は、指定された名前空間とローカル名を持つ属性が存在すれば、その属性値が文字列として返されます。もし属性が見つからない場合はnullが返されます。

サンプルコードでは、SVG要素内の<a>タグにあるxlink:href属性の取得を例にしています。ここでは、XLinkの名前空間URI（http://www.w3.org/1999/xlink）とローカル名hrefをgetAttributeNSに渡すことで、https://www.php.netというリンク先を正確に取得しています。名前空間を持たない通常の属性（例: target）を取得する場合は、getAttributeメソッドを使用しますので、この使い分けを理解することが重要です。

getAttributeNSは、xlink:hrefのように名前空間を持つ属性の値を取得するためのメソッドです。最も重要な注意点は、最初の引数にxlinkのようなプレフィックスではなく、http://www.w3.org/1999/xlinkといった完全な名前空間URIを指定することです。２番目の引数には、hrefのようなプレフィックスを含まない属性のローカル名を指定してください。属性が存在しない場合や、指定した名前空間に合致しない場合はnullが返されるため、取得後の値は必ずnullチェックを行い、適切な処理を実装することが大切です。名前空間を持たない通常の属性を取得する場合は、getAttribute()を使用します。PHP 8.2からDom\HTMLElementが導入されましたが、DOMElementクラスでも同様に利用でき、互換性があります。

PHP 8 アトリビュートを ReflectionClass で取得する


1<?php
2
3// Step 1: カスタムアトリビュート（属性）を定義します。
4// PHP 8では、`#[Attribute]` を付与したクラスとしてアトリビュートを定義します。
5// `Attribute::TARGET_CLASS | Attribute::TARGET_METHOD` は、このアトリビュートがクラスとメソッドに適用可能であることを示します。
6#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
7class MyMetadata
8{
9    public function __construct(
10        public string $description,
11        public int $version = 1
12    ) {}
13}
14
15// Step 2: 定義したカスタムアトリビュートをクラスやメソッドに適用します。
16// `#[...]` 構文を使ってアトリビュートを指定します。
17#[MyMetadata(description: 'これは、特定の情報を保持するためのサンプルクラスです。')]
18class DataProcessor
19{
20    #[MyMetadata(description: 'このメソッドは入力データを処理し、結果を返します。', version: 2)]
21    public function process(string $input): string
22    {
23        return "Processed: " . $input;
24    }
25
26    public function fetch(int $id): string
27    {
28        return "Data for ID: " . $id;
29    }
30}
31
32// Step 3: ReflectionClass を使用して、クラスやメソッドのアトリビュートを読み取ります。
33// `getAttributes()` メソッドは、PHP 8で導入されたアトリビュートを取得するために使われます。
34function demonstrateAttributeReflection(): void
35{
36    echo "--- クラスのアトリビュートの読み取り ---\n";
37    // DataProcessor クラスのリフレクションオブジェクトを作成します。
38    $reflectionClass = new ReflectionClass(DataProcessor::class);
39
40    // クラスに付与されているすべてのアトリビュートを取得します。
41    $classAttributes = $reflectionClass->getAttributes();
42
43    if (empty($classAttributes)) {
44        echo "クラス '{$reflectionClass->getName()}' にアトリビュートは見つかりませんでした。\n";
45    } else {
46        foreach ($classAttributes as $attribute) {
47            // アトリビュートのインスタンスを作成し、そのプロパティにアクセスします。
48            $attributeInstance = $attribute->newInstance();
49            echo "アトリビュート名: " . $attribute->getName() . "\n";
50            echo "  説明: " . $attributeInstance->description . "\n";
51            echo "  バージョン: " . $attributeInstance->version . "\n";
52            echo "---------------------------------\n";
53        }
54    }
55
56    echo "\n--- メソッドのアトリビュートの読み取り ---\n";
57    // クラス内の各メソッドをループ処理します。
58    foreach ($reflectionClass->getMethods() as $reflectionMethod) {
59        echo "メソッド名: {$reflectionMethod->getName()}\n";
60
61        // メソッドに付与されているすべてのアトリビュートを取得します。
62        $methodAttributes = $reflectionMethod->getAttributes();
63
64        if (empty($methodAttributes)) {
65            echo "  アトリビュートは見つかりませんでした。\n";
66        } else {
67            foreach ($methodAttributes as $attribute) {
68                $attributeInstance = $attribute->newInstance();
69                echo "  アトリビュート名: " . $attribute->getName() . "\n";
70                echo "    説明: " . $attributeInstance->description . "\n";
71                echo "    バージョン: " . $attributeInstance->version . "\n";
72                echo "  ---------------------------------\n";
73            }
74        }
75    }
76}
77
78// 関数を実行して、アトリビュートのリフレクション結果を表示します。
79demonstrateAttributeReflection();
80

このサンプルコードは、PHP 8で導入された「アトリビュート」という機能と、それをリフレクションAPIを使って動的に読み取る方法を示しています。アトリビュートは、クラス、メソッド、プロパティなどにメタデータ（付加情報）を埋め込むための仕組みです。

まず、#[Attribute]を付与したMyMetadataクラスを定義することで、カスタムアトリビュートを作成します。これは、descriptionやversionといった情報を保持できるカスタムなタグのようなものです。次に、このMyMetadataアトリビュートをDataProcessorクラスやそのprocessメソッドの上に#[MyMetadata(...)]という形で適用します。これにより、コード自身にそのコードに関する補足情報が記述されます。

ReflectionClassやReflectionMethodのgetAttributes()メソッドは、対象となるクラスやメソッドに付与されているすべてのアトリビュート情報を取得するために使用されます。このメソッドは、ReflectionAttributeオブジェクトの配列を戻り値として返します。ReflectionAttributeオブジェクトからは、アトリビュートの名前や、newInstance()メソッドを使ってアトリビュートのインスタンスを生成し、そのコンストラクタで渡された値（例：description、version）を動的に読み出すことができます。この機能により、アプリケーションは実行時にコードのメタデータに基づいて、柔軟な処理や挙動の制御が可能になります。

このコードは、PHP 8で導入されたアトリビュートという新機能と、それを実行時に読み取るリフレクション機能の利用方法を示しています。アトリビュートクラスを定義する際には、必ず#[Attribute]を付与し、そのアトリビュートが適用可能な対象（例: Attribute::TARGET_CLASSなど）を指定することが重要です。ReflectionClassやReflectionMethodのgetAttributes()メソッドは、直接アトリビュートの値を返すのではなく、ReflectionAttributeオブジェクトの配列を返します。実際にアトリビュートが持つプロパティの値にアクセスするためには、$attribute->newInstance()を呼び出してアトリビュートのインスタンスを作成する必要があります。この機能は、コードにメタデータ（付加情報）を埋め込み、実行時にその情報を動的に利用する高度な用途、特にフレームワーク開発などで役立ちます。