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

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

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

基本的な使い方

getRootNodeメソッドは、Dom\Documentクラスに属するメソッドで、ドキュメントのルートノードを返します。このメソッドは、XMLドキュメントまたはHTMLドキュメント全体の構造を表現するDom\Elementオブジェクトを取得するために使用されます。具体的には、ドキュメントの最上位の要素ノード、例えばHTMLドキュメントにおける <html> 要素、またはXMLドキュメントにおけるルート要素を返します。

getRootNodeメソッドを使用することで、ドキュメント全体を処理するための出発点となるノードを簡単に取得できます。返り値はDom\Elementオブジェクトであるため、その要素の属性や子ノードにアクセスしたり、DOM操作を行うことができます。

このメソッドは引数を必要としません。もしドキュメントにルートノードが存在しない場合（例えば、空のドキュメントや、ルートノードがまだ作成されていない場合など）は、nullを返します。したがって、getRootNodeメソッドの返り値を使用する前に、nullチェックを行うことが推奨されます。

getRootNodeメソッドは、DOMDocumentオブジェクトが表すドキュメントの構造を解析し、操作するための基本的な機能を提供します。DOM（Document Object Model）は、XMLやHTMLドキュメントをツリー構造で表現し、プログラムからその構造にアクセスし、変更するためのAPIです。getRootNodeメソッドを利用することで、このツリー構造の最上位ノードから、ドキュメント全体の走査や操作を開始することができます。

このメソッドは、DOMDocumentオブジェクトが表すドキュメントが有効なXMLまたはHTMLドキュメントであり、ルートノードが適切に定義されている場合に、最も効果を発揮します。

構文(syntax)


1Dom\Document::getRootNode(): ?Dom\Node

引数(parameters)

引数なし

引数はありません

戻り値(return)

Dom\Node

このメソッドは、DOMDocumentオブジェクトのルートノードを表すDom\Nodeオブジェクトを返します。

サンプルコード

PHP: Dom\Document::getRootNode() でルートノードを取得する


1<?php
2
3// Dom\Document クラスのインスタンスを作成します。
4// これはXMLやHTMLドキュメントを表すオブジェクトです。
5$document = new Dom\Document();
6
7// 簡単なXML文字列をドキュメントにロードします。
8// この例では '<root>' がドキュメントのルート要素（最上位の要素）になります。
9$xmlString = '<root><child>サンプルテキスト</child></root>';
10
11// loadXML() メソッドでXML文字列をパースし、ドキュメントに読み込みます。
12// 失敗した場合に備えてエラーチェックを行うとより堅牢になりますが、
13// この例では成功するものと仮定します。
14if ($document->loadXML($xmlString)) {
15    // getRootNode() メソッドを使用して、ドキュメントのルートノードを取得します。
16    // ドキュメントにロードされたXML/HTMLの最上位の要素が返されます。
17    $rootNode = $document->getRootNode();
18
19    // 取得したルートノードが Dom\Element 型であることを確認し、その情報を表示します。
20    if ($rootNode instanceof Dom\Element) {
21        echo "ルートノードのタグ名: " . $rootNode->tagName . PHP_EOL;
22        echo "ルートノードのノード名: " . $rootNode->nodeName . PHP_EOL;
23        echo "ルートノードのノードタイプ: " . $rootNode->nodeType . " (ELEMENT_NODE)" . PHP_EOL;
24    } else {
25        echo "エラー: ルートノードが見つからないか、期待される型ではありません。" . PHP_EOL;
26    }
27} else {
28    echo "エラー: XMLのロードに失敗しました。" . PHP_EOL;
29}
30
31?>

PHP 8のDom\Document::getRootNode()メソッドは、XMLやHTMLドキュメントをプログラムで扱う際に、ドキュメントの最も上位に位置する要素、つまり「ルートノード」を取得するために使用されます。このメソッドはDom\Documentクラスに属し、引数を一切取りません。

サンプルコードでは、まずDom\Documentオブジェクトを作成し、loadXML()メソッドで特定のXML文字列を読み込んでいます。XMLが正常にロードされた後、$document->getRootNode()を呼び出すことで、ドキュメントの最上位要素である<root>要素がDom\Nodeオブジェクトとして取得されます。

取得されたルートノードは通常Dom\Elementのインスタンスとなるため、サンプルコードではそのタグ名やノード名を表示し、正しく最上位要素が取得できているかを確認しています。このメソッドの戻り値はDom\Node型で、XMLやHTMLのツリー構造の起点となる要素を提供します。これにより、ドキュメント全体の構造を把握し、その後の要素操作や情報抽出の出発点として活用できます。

このサンプルコードでgetRootNode()メソッドを利用する際は、事前にDom\Documentオブジェクトに有効なXMLやHTMLがロードされていることが必須です。loadXML()などのロード処理が成功したかを必ず確認し、エラーハンドリングを怠らないようにしてください。getRootNode()の戻り値はDom\Node型ですが、通常は要素を表すDom\Element型であることが多いため、instanceof演算子で型をチェックすると、安全にプロパティへアクセスできます。また、ドキュメントが空の場合やルート要素が明確でない場合、期待するノードが取得できない可能性があるため、戻り値がnullではないかを確認する処理を加えると、より堅牢なコードになります。

PHP Dom\Document::getRootNode() でルートノードを取得する


1<?php
2
3/**
4 * Dom\Document::getRootNode() メソッドの使用例を示します。
5 * HTML ドキュメントをロードし、そのルートノードを取得して情報を表示します。
6 */
7function demonstrateGetRootNode(): void
8{
9    // HTML ドキュメントの文字列を定義
10    $htmlString = '<!DOCTYPE html>
11<html>
12<head>
13    <title>サンプルドキュメント</title>
14</head>
15<body>
16    <h1>こんにちは</h1>
17    <p>これはルートノードの配下にある要素です。</p>
18</body>
19</html>';
20
21    // Dom\Document クラスの新しいインスタンスを作成
22    $dom = new Dom\Document();
23
24    // HTML 文字列を DOM オブジェクトにロード
25    // LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD は、
26    // HTML5 のように暗黙的な <html> や <body> タグの追加、
27    // およびデフォルトの DTD を防ぐためのオプションです。
28    // これにより、より厳密に指定したHTMLをパースできます。
29    if ($dom->loadHTML($htmlString, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD)) {
30        echo "HTMLドキュメントが正常にロードされました。\n\n";
31
32        // ドキュメントのルートノードを取得
33        // getRootNode() メソッドは Dom\Node オブジェクトを返します。
34        // このHTMLの場合、ルートノードは <html> 要素になります。
35        $rootNode = $dom->getRootNode();
36
37        // ルートノードが正常に取得できたか確認
38        if ($rootNode !== null) {
39            echo "ルートノードが見つかりました。\n";
40            echo "---------------------------------\n";
41            echo "ノード名: " . $rootNode->nodeName . "\n"; // 例: html
42            echo "ノードタイプ: " . $rootNode->nodeType . " (Dom\Node::ELEMENT_NODE は 1)\n";
43            // ルートノードの最初の属性（存在する場合）を表示
44            echo "最初の属性名: " . ($rootNode->attributes->item(0)?->name ?? 'なし') . "\n";
45            // ルートノードのテキストコンテンツの冒頭を表示
46            echo "テキストコンテンツの冒頭: " . mb_substr($rootNode->textContent, 0, 50) . "...\n";
47        } else {
48            echo "エラー: ルートノードが見つかりませんでした。\n";
49        }
50    } else {
51        echo "エラー: HTMLドキュメントのロードに失敗しました。\n";
52    }
53}
54
55// 上記の関数を実行して、Dom\Document::getRootNode() の動作を確認します。
56demonstrateGetRootNode();
57
58?>

Dom\Document::getRootNode()メソッドは、HTMLやXMLなどのドキュメント構造（DOM）を扱う際に、そのドキュメントの一番上位にある要素（ルートノード）を取得するために使用されます。このメソッドは引数を必要とせず、ドキュメントが持つルートのDom\Nodeオブジェクトを返します。

このメソッドを使用するには、まずDom\Documentクラスのインスタンスを作成し、loadHTML()などのメソッドでドキュメントの内容を読み込む必要があります。サンプルコードでは、定義されたHTML文字列をロードした後、$dom->getRootNode()を呼び出すことで、ドキュメントの最上位要素である<html>要素をDom\Nodeオブジェクトとして取得しています。取得したルートノードからは、その要素名（nodeName）やノードタイプ（nodeType）、子要素やテキストコンテンツなど、ドキュメント全体を操作する上で基点となる様々な情報を参照することが可能になります。

Dom\Document::getRootNode()は、HTMLやXMLドキュメントの最上位要素（通常は<html>やルート要素）を取得する際に利用します。サンプルコードのようにloadHTML()でドキュメントを読み込む際は、必ずその成功を条件分岐で確認してください。HTMLの構造が不完全だと、パース結果や取得できるルートノードが意図せず変化する可能性があります。getRootNode()メソッドはルートノードが見つからない場合にnullを返すことがあるため、取得したDom\Nodeオブジェクトがnullでないことを必ずチェックすることが重要です。また、loadHTML()に渡すLIBXML系のオプションは、ドキュメントの解釈に大きく影響するため、その役割を理解した上で適切に設定してください。