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

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

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

基本的な使い方

lookupNamespaceURIメソッドは、Dom\HTMLDocumentクラスに属するメソッドであり、ノードに関連付けられた接頭辞に基づいて名前空間 URI を検索するために使用されます。具体的には、引数として渡された接頭辞に対応する名前空間 URI を返します。

このメソッドは、HTMLドキュメント内で特定の接頭辞がどの名前空間に関連付けられているかをプログラム的に知りたい場合に非常に役立ちます。例えば、HTMLドキュメント内にカスタム要素や属性があり、それらが特定の名前空間に属している場合に、このメソッドを使用することで、その名前空間 URI を取得できます。

メソッドの引数には、検索したい接頭辞を文字列として指定します。もし指定された接頭辞がドキュメント内で定義されていない場合、このメソッドは null を返します。これにより、指定された接頭辞が存在するかどうかを簡単に確認できます。

Dom\HTMLDocumentオブジェクトに対してこのメソッドを呼び出すことで、HTMLドキュメントのコンテキスト内で名前空間の解決を行うことができます。これは、XML名前空間の概念をHTMLドキュメントに適用する場合に特に重要となります。例えば、SVGやMathMLなどの名前空間を使用しているHTMLドキュメントを扱う際に、名前空間の解決が必要となる場面で活用できます。

このメソッドを使用することで、開発者はHTMLドキュメント内の名前空間をより柔軟に管理し、特定の名前空間に属する要素や属性を効率的に処理することができます。

構文(syntax)


1public Dom\Node|null lookupNamespaceURI ( string $prefix ): ?Dom\Node

引数(parameters)

string|null $prefix

string|null $prefix: 名前空間のURIを検索する接頭辞（プレフィックス）。null を指定すると、デフォルトの名前空間 URI を検索します。

戻り値(return)

?string

指定された要素が名前空間URIを持たない場合はnullを、持っている場合はその名前空間URIを表す文字列を返します。

サンプルコード

PHPのDom\HTMLDocumentでルート名前空間URIを検索する


1<?php
2
3/**
4 * HTML文書をパースし、ルート要素のデフォルト名前空間URIを検索する関数。
5 *
6 * この関数は、Dom\HTMLDocumentクラスのlookupNamespaceURIメソッドを使用して、
7 * HTML文書（特にXHTMLのように名前空間が宣言されている場合）の
8 * ルート要素に設定されているデフォルト名前空間URIを特定する方法を示します。
9 * 引数にnullを渡すことで、プレフィックスなしの（デフォルト）名前空間を検索します。
10 */
11function findHtmlRootNamespaceUri(): void
12{
13    // XHTMLのように名前空間が定義されたHTML文字列を作成します。
14    // 'xmlns="http://www.w3.org/1999/xhtml"' は、
15    // このHTML文書のルート要素（<html>）のデフォルト名前空間を宣言しています。
16    $htmlString = <<<HTML
17    <!DOCTYPE html>
18    <html xmlns="http://www.w3.org/1999/xhtml" lang="ja">
19    <head>
20        <meta charset="utf-8">
21        <title>名前空間のテスト</title>
22    </head>
23    <body>
24        <h1>Dom\HTMLDocument 名前空間検索の例</h1>
25        <p>この文書のルート要素の名前空間を調べます。</p>
26    </body>
27    </html>
28    HTML;
29
30    // Dom\HTMLDocument オブジェクトを新しく作成します。
31    // PHP 8で導入されたこのクラスは、HTML5のパースに適しています。
32    $document = new Dom\HTMLDocument();
33
34    // HTML文字列をドキュメントにロードします。
35    // これにより、DOMツリーが構築され、名前空間情報も解析されます。
36    $document->loadHTML($htmlString);
37
38    // ドキュメントのデフォルト名前空間URIを検索します。
39    // lookupNamespaceURI(null) は、プレフィックスが指定されていない名前空間、
40    // つまりデフォルト名前空間（xmlns属性で宣言されたもの）を返します。
41    // これは、HTML文書の「ルート」要素に適用される名前空間を調べる一般的な方法です。
42    $namespaceUri = $document->lookupNamespaceURI(null);
43
44    echo "HTML文書のルート要素のデフォルト名前空間URI:\n";
45    if ($namespaceUri !== null) {
46        echo $namespaceUri . "\n";
47    } else {
48        echo "デフォルト名前空間は定義されていません。\n";
49    }
50}
51
52// 定義した関数を実行します。
53findHtmlRootNamespaceUri();
54
55?>

PHPのDom\HTMLDocumentクラスが提供するlookupNamespaceURIメソッドは、HTML文書内の要素に設定された名前空間URIを検索するために使用されます。このメソッドは、特にXHTMLのように名前空間が宣言されているHTML文書において、そのルート要素（通常は<html>タグ）に適用されるデフォルトの名前空間URIを特定する際に役立ちます。

引数$prefixには検索したい名前空間のプレフィックスを文字列で渡しますが、nullを渡すことで、プレフィックスが指定されていない「デフォルト名前空間」のURIを検索できます。戻り値は、該当する名前空間URIが見つかればその文字列を返し、見つからなければnullを返します。

サンプルコードでは、xmlns="http://www.w3.org/1999/xhtml"とデフォルト名前空間が宣言されたHTML文字列をDom\HTMLDocumentに読み込みます。その後、lookupNamespaceURI(null)を呼び出すことで、この文書のルート要素に設定されているhttp://www.w3.org/1999/xhtmlというデフォルト名前空間URIを取得し、出力するまでの流れを示しています。この機能は、HTML文書がどの規格に準拠しているかなどをプログラムから動的に判断したい場合に活用できます。

このサンプルコードは、XMLベースのHTML（XHTMLなど）に定義される「名前空間」を検索するものです。PHPのコード構造を定義するnamespaceキーワードとは全く異なる概念ですので混同しないようご注意ください。lookupNamespaceURIメソッドは、引数にnullを渡すことでプレフィックスなしのデフォルト名前空間を検索します。通常のHTML5文書ではデフォルト名前空間が明示的に宣言されないことが多いため、検索結果がnullになる可能性があり、その際の処理を必ず記述してください。また、利用しているDom\HTMLDocumentクラスはPHP 8以降で導入されたものですので、古いバージョンでは動作しません。

Dom\HTMLDocument::lookupNamespaceURI でネームスペースが見つからない例


1<?php
2
3// Dom\HTMLDocument クラスは、HTML5 ドキュメントを解析し、DOM (Document Object Model) として操作するためのクラスです。
4// lookupNamespaceURI メソッドは、指定されたプレフィックスに対応するネームスペースURIを検索します。
5
6/**
7 * Dom\HTMLDocument::lookupNamespaceURI メソッドの利用例
8 *
9 * この関数は、HTML文書内で特定のプレフィックスを持つネームスペースURIが
10 * 見つからないケース (null が返されるケース) を中心にデモンストレーションします。
11 *
12 * 【重要】この「ネームスペース」はXML/HTMLの要素や属性に適用されるものであり、
13 * PHP言語のコード整理に使う「namespace MyProject;」とは全く異なる概念です。
14 */
15function demonstrateHtmlNamespaceLookup(): void
16{
17    // 標準的なHTML5ドキュメントをロードします。
18    // HTML5は通常、要素に明示的なネームスペースプレフィックスを持ちません。
19    $htmlContent = <<<HTML
20<!DOCTYPE html>
21<html>
22<head>
23    <title>HTML Namespace Lookup Example</title>
24</head>
25<body>
26    <h1>Standard HTML5 Document</h1>
27    <p>この文書は、明示的なXMLネームスペースやプレフィックスを定義していません。</p>
28</body>
29</html>
30HTML;
31
32    // Dom\HTMLDocument のインスタンスを作成し、HTMLコンテンツをロード
33    $document = new Dom\HTMLDocument();
34    $document->loadHTML($htmlContent);
35
36    echo "--- Dom\\HTMLDocument::lookupNamespaceURI のデモンストレーション ---\n\n";
37
38    // 1. 存在しないプレフィックスのネームスペースURIを検索
39    // 'customprefix' というプレフィックスはHTML文書内に定義されていないため、URIは見つかりません。
40    // これは、キーワード「php namespace not found」に最も関連するケースです。
41    $nonExistentPrefix = 'customprefix';
42    $uriNonExistent = $document->lookupNamespaceURI($nonExistentPrefix);
43
44    echo "プレフィックス '{$nonExistentPrefix}' のネームスペースURIを検索:\n";
45    if ($uriNonExistent === null) {
46        echo "  -> 見つかりませんでした。(null)\n";
47        echo "  (これは、指定されたプレフィックスに対応するネームスペースURIがこの文書内に定義されていないことを意味します。)\n\n";
48    } else {
49        echo "  -> {$uriNonExistent}\n\n";
50    }
51
52    // 2. デフォルトネームスペース (プレフィックスが null) を検索
53    // 標準的なHTML5文書では、ドキュメントレベルでデフォルトネームスペースURIは設定されていません。
54    $defaultPrefix = null;
55    $uriDefault = $document->lookupNamespaceURI($defaultPrefix);
56
57    echo "デフォルトプレフィックス (null) のネームスペースURIを検索:\n";
58    if ($uriDefault === null) {
59        echo "  -> 見つかりませんでした。(null)\n";
60        echo "  (一般的なHTML5文書では、ドキュメントレベルのデフォルトネームスペースURIは通常ありません。)\n\n";
61    } else {
62        echo "  -> {$uriDefault}\n\n";
63    }
64
65    echo "補足: Dom\\HTMLDocument::lookupNamespaceURI は、標準的なHTML5文書において、\n";
66    echo "ほとんどの場合、ネームスペースURIが見つからない (nullが返る) 結果になります。\n";
67}
68
69// 関数を実行してデモンストレーションを開始
70demonstrateHtmlNamespaceLookup();

PHP 8のDom\HTMLDocument::lookupNamespaceURIメソッドは、HTML文書内で指定されたプレフィックスに対応するネームスペースURIを検索するために使用されます。ここでいう「ネームスペース」とは、XMLやHTMLの要素や属性の衝突を防ぐために使われる仕組みであり、PHP言語のコード整理に使うnamespaceキーワードとは全く異なる概念ですのでご注意ください。

このメソッドの引数$prefixには、検索したいネームスペースのプレフィックスを文字列で指定します。nullを指定した場合は、文書のデフォルトネームスペースが検索対象となります。戻り値は、対応するネームスペースURIが見つかった場合にはそのURIを文字列で返しますが、見つからなかった場合にはnullを返します。

サンプルコードでは、標準的なHTML5文書を用いてこのメソッドの挙動をデモンストレーションしています。HTML5文書は通常、明示的なネームスペースプレフィックスを持たないため、存在しないプレフィックス（例: 'customprefix'）を指定して検索したり、デフォルトネームスペース（null）を検索したりすると、ほとんどの場合nullが返されます。これは、指定されたプレフィックスに対応するネームスペースURIが文書内に定義されていない、つまり「ネームスペースが見つからない」状況を示しています。このメソッドは、特にXMLベースのHTMLやSVGなどのドキュメントを扱う際に、要素の正しいネームスペースを特定するために役立ちます。

「Dom\HTMLDocument::lookupNamespaceURI」メソッドを利用する際は、まず「ネームスペース」がPHP言語のコード整理に用いるnamespaceキーワードとは全く異なる概念であることに注意してください。これはXMLやHTMLの要素・属性に適用されるルールです。

このメソッドは、標準的なHTML5文書に対して使用すると、ほとんどの場合nullを返します。これは、一般的なHTML5文書が要素に明示的なネームスペースプレフィックスを持たないためです。nullが返された場合、それはエラーではなく、指定されたプレフィックスに対応するネームスペースURIが文書内に見つからないことを意味します。この挙動を理解し、特にネームスペースが明示的に定義されているXML文書やXHTML文書を扱う場合に有効活用してください。引数にnullを指定するとデフォルトネームスペースを検索しますが、HTML5ではこれも通常nullが返されます。