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

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

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

基本的な使い方

lookupNamespaceURIメソッドは、指定されたプレフィックスに関連付けられた名前空間 URI を取得するメソッドです。Dom\HTMLElement クラスに属しており、特定の HTML 要素ノード内で、与えられたプレフィックスに対応する名前空間 URI を検索するために使用されます。

このメソッドは、要素ノードが属するドキュメントのコンテキスト内で、名前空間プレフィックスの解決を行います。具体的には、要素自身、親要素、さらに上位の祖先要素を順番に検索し、指定されたプレフィックスが名前空間 URI にマップされているかを確認します。もしプレフィックスが要素の属性として定義されている場合、または親要素で定義されている場合は、対応する名前空間 URI が返されます。プレフィックスがどの要素にも定義されていない場合は、null が返されます。

システムエンジニアを目指す初心者の方にとって、このメソッドは、XML や HTML ドキュメントを扱う際に、名前空間を正しく理解し、処理するために重要な役割を果たします。例えば、異なる組織や異なるアプリケーションで定義された要素が混在するドキュメントを扱う場合、名前空間を利用して要素を区別し、適切に処理する必要があります。lookupNamespaceURI メソッドを使用することで、要素のプレフィックスから対応する名前空間 URI を取得し、要素がどの名前空間に属しているかを判断することができます。これにより、名前空間に基づいた処理や検証を正確に行うことが可能になります。

構文(syntax)


1Dom\HTMLElement::lookupNamespaceURI(string $prefix): ?string

引数(parameters)

?string $prefix

?string $prefix: 名前空間のプレフィックスを指定する文字列。null を指定すると、デフォルトの名前空間の URI が返されます。

戻り値(return)

?string

指定された要素のnamespace URIを文字列で返します。対応するnamespace URIが見つからない場合は、nullを返します。

サンプルコード

PHP Dom\HTMLElement 名前空間URIを検索する


1<?php
2
3/**
4 * HTMLドキュメントの要素から名前空間URIを検索する例。
5 * 主にルート要素や特定のプレフィックスを持つ名前空間の検索を示します。
6 */
7function demonstrateNamespaceLookup(): void
8{
9    // XHTML形式のHTMLコンテンツを定義します。
10    // ルート要素<html>にデフォルトの名前空間と'svg'プレフィックスの名前空間が定義されています。
11    $htmlContent = <<<HTML
12<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
13<html xmlns="http://www.w3.org/1999/xhtml" xmlns:svg="http://www.w3.org/2000/svg">
14<head>
15    <title>名前空間の検索</title>
16</head>
17<body>
18    <h1>名前空間の検索 (PHP Dom\\HTMLElement)</h1>
19    <svg:svg width="100" height="100">
20        <svg:circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="red" />
21    </svg:svg>
22    <p>この段落はXHTMLの名前空間に属します。</p>
23</body>
24</html>
25HTML;
26
27    // Dom\HTMLDocument オブジェクトを作成し、HTMLコンテンツを読み込みます。
28    $document = new Dom\HTMLDocument();
29    $document->loadHTML($htmlContent);
30
31    // ドキュメントのルート要素 (<html>) を取得します。
32    // これは Dom\HTMLElement のインスタンスになります。
33    $htmlElement = $document->documentElement;
34
35    if ($htmlElement instanceof Dom\HTMLElement) {
36        echo "--- HTMLルート要素のコンテキストでの名前空間検索 ---\n";
37
38        // キーワード「ルート」に関連して、ルート要素のデフォルト名前空間を検索します。
39        // デフォルトの名前空間は、プレフィックスとして空文字列または null を渡すことで検索できます。
40        $defaultNamespace = $htmlElement->lookupNamespaceURI('');
41        echo "  - デフォルト名前空間 (プレフィックスなし): " . ($defaultNamespace ?? 'なし') . "\n";
42
43        // 'svg' プレフィックスに対応する名前空間URIを検索します。
44        $svgNamespace = $htmlElement->lookupNamespaceURI('svg');
45        echo "  - 'svg' プレフィックスの名前空間URI: " . ($svgNamespace ?? 'なし') . "\n";
46
47        // 存在しないプレフィックスの名前空間を検索します。結果は null になります。
48        $unknownNamespace = $htmlElement->lookupNamespaceURI('foo');
49        echo "  - 'foo' プレフィックスの名前空間URI (存在しない): " . ($unknownNamespace ?? 'なし') . "\n";
50
51        // 他の要素のコンテキストでも名前空間を検索できます。
52        $bodyElement = $document->getElementsByTagName('body')->item(0);
53        if ($bodyElement instanceof Dom\HTMLElement) {
54            echo "\n--- body要素のコンテキストでの名前空間検索 ---\n";
55            $bodyDefaultNamespace = $bodyElement->lookupNamespaceURI('');
56            echo "  - body要素のデフォルト名前空間: " . ($bodyDefaultNamespace ?? 'なし') . "\n";
57
58            // body要素の親要素で定義された'svg'プレフィックスも認識されます。
59            $bodySvgNamespace = $bodyElement->lookupNamespaceURI('svg');
60            echo "  - body要素から見た 'svg' プレフィックスの名前空間URI: " . ($bodySvgNamespace ?? 'なし') . "\n";
61        }
62    } else {
63        echo "エラー: ドキュメントのルート要素が Dom\\HTMLElement のインスタンスではありません。\n";
64    }
65}
66
67// 関数を実行します。
68demonstrateNamespaceLookup();

PHPのDom\HTMLElement::lookupNamespaceURIメソッドは、HTML要素に指定されたプレフィックスに対応する名前空間URIを検索するために使われます。Dom\HTMLElementは、HTMLドキュメント内の個々の要素（例えば<html>や<body>など）を表すクラスです。

このメソッドは?string $prefixという引数を取り、検索したい名前空間のプレフィックスを文字列で指定します。例えば、xmlns:svg="..."のように定義されている名前空間であれば'svg'を渡します。もし、プレフィックスが指定されていないデフォルトの名前空間（xmlns="..."）を検索したい場合は、引数に空文字列''またはnullを指定します。

戻り値は?string型で、見つかった名前空間URIを文字列で返します。指定されたプレフィックスに対応する名前空間が要素またはその祖先要素で見つからない場合はnullを返します。

サンプルコードでは、XHTML形式のHTMLコンテンツをDom\HTMLDocumentに読み込み、ドキュメントのルート要素である<html>を取得しています。このルート要素のコンテキストでlookupNamespaceURIを呼び出し、デフォルトの名前空間（プレフィックスなし）や、svgプレフィックスに紐づく名前空間URIを検索しています。これにより、要素の属性として定義された名前空間情報をプログラムから正確に取得できることが示されています。また、子要素である<body>からも親要素で定義された名前空間を検索できる様子も確認できます。

このサンプルコードは、HTML要素から名前空間URIを検索する方法を示しています。デフォルトの名前空間を検索するには、引数に空文字列''またはnullを渡します。指定したプレフィックスに対応する名前空間が見つからない場合、メソッドはnullを返しますので、結果がnullの場合の処理を必ず検討してください。名前空間はHTML要素の親子関係を通じて継承されるため、子要素からでも親要素で定義された名前空間を検索できます。特にXHTMLやSVGなどのXML系の内容を含むHTMLを扱う際に役立ちます。また、document->documentElementの戻り値は必ずしもDom\HTMLElementとは限らないため、instanceofで型を確認する習慣をつけると安全に利用できます。

PHP: Dom\HTMLElement::lookupNamespaceURIで名前空間URIを取得する


1<?php
2
3// DOMDocumentを新規作成し、XMLを扱うための準備をします。
4$dom = new DOMDocument('1.0', 'UTF-8');
5$dom->formatOutput = true; // 出力を整形するために設定（必須ではありません）
6
7// 様々な名前空間宣言を含むXML文字列を定義します。
8// - <root>要素はデフォルト名前空間 (http://default.namespace.com) と、
9//   'ex' (http://example.com/ns)、'alt' (http://alternative.com/ns) という
10//   2つのプレフィックス付き名前空間を宣言しています。
11// - <ex:item>要素は'ex'プレフィックスを使用しています。
12// - <anotherItem>要素はプレフィックスがないため、デフォルト名前空間を使用します。
13// - <nestedItem>要素は独自の'tmp'プレフィックスを宣言しており、これは<ex:item>のスコープ外です。
14$xmlString = <<<XML
15<root xmlns="http://default.namespace.com" xmlns:ex="http://example.com/ns" xmlns:alt="http://alternative.com/ns">
16    <ex:item id="item1">
17        <subitem />
18    </ex:item>
19    <anotherItem id="item2">
20        <nestedItem xmlns:tmp="http://temp.com/ns"/>
21    </anotherItem>
22</root>
23XML;
24
25// 定義したXML文字列をDOMDocumentにロードします。
26$dom->loadXML($xmlString);
27
28// Dom\HTMLElement::lookupNamespaceURI メソッドをデモンストレーションするために、
29// 特定の要素（ここでは <ex:item>）を取得します。
30// getElementsByTagNameNS() は DOMElement オブジェクトを返しますが、
31// DOMElement は Dom\HTMLElement インターフェースを実装しています。
32$targetElement = $dom->getElementsByTagNameNS('http://example.com/ns', 'item')->item(0);
33
34// ターゲット要素が正常に取得され、Dom\HTMLElement のインスタンスであることを確認します。
35if ($targetElement instanceof Dom\HTMLElement) {
36    echo "--- Dom\\HTMLElement::lookupNamespaceURI のデモンストレーション ---\n\n";
37
38    // ケース1: ターゲット要素に対して有効なプレフィックス ('ex') を検索します。
39    // このプレフィックスは祖先要素で宣言されており、<ex:item>で使われています。
40    // 期待される結果: "http://example.com/ns"
41    $uriEx = $targetElement->lookupNamespaceURI('ex');
42    echo "プレフィックス 'ex' を検索: " . ($uriEx ?? "null (プレフィックスが見つかりません)") . "\n";
43
44    // ケース2: ターゲット要素で直接使われていないが、祖先で宣言されているプレフィックス ('alt') を検索します。
45    // 名前空間宣言は子要素に継承されるため、見つかるはずです。
46    // 期待される結果: "http://alternative.com/ns"
47    $uriAlt = $targetElement->lookupNamespaceURI('alt');
48    echo "プレフィックス 'alt' を検索: " . ($uriAlt ?? "null (プレフィックスが見つかりません)") . "\n";
49
50    // ケース3: デフォルト名前空間（プレフィックスなし、空文字列で表現）を検索します。
51    // <root>要素でデフォルト名前空間が宣言されています。
52    // 期待される結果: "http://default.namespace.com"
53    $uriDefault = $targetElement->lookupNamespaceURI('');
54    echo "デフォルト名前空間（空文字列）を検索: " . ($uriDefault ?? "null (プレフィックスが見つかりません)") . "\n";
55
56    // ケース4: ターゲット要素のスコープ内や祖先で宣言されていないプレフィックス ('nonexistent') を検索します。
57    // この場合、PHPのXML名前空間解決において「見つからない」状況となります。
58    // 期待される結果: null
59    $uriNonExistent = $targetElement->lookupNamespaceURI('nonexistent');
60    echo "プレフィックス 'nonexistent' を検索: " . ($uriNonExistent ?? "null (プレフィックスが見つかりません)") . "\n";
61
62    // ケース5: XMLツリーの異なるブランチ（別の祖先を持つ要素）の、子孫要素で宣言されているプレフィックス ('tmp') を検索します。
63    // $targetElement のスコープからは 'tmp' は認識されません。
64    // 期待される結果: null
65    $uriTmp = $targetElement->lookupNamespaceURI('tmp');
66    echo "プレフィックス 'tmp' (別ブランチで定義) を検索: " . ($uriTmp ?? "null (プレフィックスが見つかりません)") . "\n";
67
68} else {
69    // XML構造や検索パスが間違っている場合に表示されるエラーメッセージです。
70    echo "エラー: XMLドキュメントからターゲット要素 (ex:item) を見つけることができませんでした。\n";
71}
72

PHP 8で導入されたDom\HTMLElement::lookupNamespaceURIメソッドは、XML文書内の特定の要素から、指定されたプレフィックスに対応する名前空間URIを検索する際に使用します。

このメソッドは、?string $prefixという引数を受け取ります。これは検索したい名前空間のプレフィックスを文字列で指定します。例えば、exのようなプレフィックスを渡します。要素のデフォルト名前空間を検索する場合は空文字列''を指定します。

戻り値は?string型で、見つかった名前空間URIを文字列として返します。もし該当するプレフィックスの名前空間が、その要素のスコープ内（要素自身やその祖先要素で宣言されている範囲）に見つからない場合は、nullを返します。

サンプルコードでは、<ex:item>要素を例に挙げています。lookupNamespaceURI('ex')のように、要素が使用しているプレフィックスを渡すと、宣言されている名前空間URI（http://example.com/ns）が返されます。また、lookupNamespaceURI('alt')のように、要素自身では使用していないものの、その祖先で宣言されているプレフィックスに対しても、名前空間が継承されるため、対応するURI（http://alternative.com/ns）が返されます。

一方、lookupNamespaceURI('nonexistent')のように宣言されていないプレフィックスや、lookupNamespaceURI('tmp')のように、別の要素のスコープ内でのみ有効なプレフィックスを検索しようとすると、メソッドはnullを返します。これは、指定されたプレフィックスが現在の要素のスコープ内で認識できない状態、つまり「php namespace not found」の状況を示しています。このメソッドを利用することで、XMLの名前空間の解決ロジックを正確に把握し、プログラムで利用できます。

lookupNamespaceURIはXML要素に定義された名前空間URIを検索するメソッドです。引数$prefixには空文字列でデフォルト名前空間を指定でき、見つからない場合はnullを返しますので、必ずnullチェックを行い適切な処理を実装してください。名前空間は宣言された要素とその子孫に適用されるため、スコープ外のプレフィックスは検索できません。このメソッドは、PHPコードの名前空間（namespaceキーワード）とは異なるXML特有の概念を扱うため、混同しないよう注意が必要です。DOMElementオブジェクトもDom\HTMLElementインターフェースを実装しているので利用できます。