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

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

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

基本的な使い方

getRootNodeメソッドは、Dom\HTMLDocumentオブジェクトが表現するHTMLドキュメントのルートノードを取得するメソッドです。Dom\HTMLDocumentクラスは、HTMLドキュメント全体をプログラムで操作するための基盤となるオブジェクトであり、このメソッドはそのドキュメントの最上位にあるノード、つまり「根」となる要素へのアクセスを提供します。

HTMLドキュメントにおいて、ルートノードは通常 <html> タグで表現される要素です。このメソッドを呼び出すと、その <html> 要素を表すDom\Nodeオブジェクトが返されます。これにより、開発者はドキュメント全体の構造を把握し、そこから子要素をたどって特定の要素を見つけたり、新しい要素を追加したり、既存の要素を変更・削除したりといったDOM（Document Object Model）操作を効率的に開始できます。

PHP 8で導入された新しいDOM拡張におけるDom\HTMLDocumentクラスの一部として提供されており、ウェブページの構造をプログラム的に解析・操作する際の基本的な出発点となります。システムエンジニアを目指す方々にとって、ウェブアプリケーション開発におけるDOM操作は不可欠なスキルであり、このgetRootNodeメソッドは、複雑なDOMツリーを扱うための最初の、そして非常に重要なステップとなるでしょう。このメソッドは引数を取りません。

構文(syntax)


1<?php
2$htmlDocument = new Dom\HTMLDocument();
3$rootNode = $htmlDocument->getRootNode();
4?>

引数(parameters)

array $options = []

array $options = []: HTMLドキュメントの解析や処理に関するオプションを指定する連想配列。デフォルトは空配列。

戻り値(return)

Dom\Node|null

このメソッドは、DOMツリーのルートノードを表すDom\Nodeオブジェクト、またはツリーが存在しない場合はnullを返します。

サンプルコード

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


1<?php
2
3// Dom\HTMLDocument クラスのインスタンスを作成します。
4// このクラスは、HTMLドキュメントをオブジェクトとして操作するために使用されます。
5$document = new Dom\HTMLDocument();
6
7// ドキュメントに簡単なHTMLコンテンツをロードします。
8// loadHTML() メソッドは、指定されたHTML文字列を解析し、DOMツリーを構築します。
9$htmlContent = '<!DOCTYPE html>
10<html>
11<head>
12    <title>サンプルドキュメント</title>
13</head>
14<body>
15    <h1>こんにちは</h1>
16    <p>これはテスト用のHTMLドキュメントです。</p>
17</body>
18</html>';
19$document->loadHTML($htmlContent);
20
21// getRootNode() メソッドを使用して、HTMLドキュメントのルートノードを取得します。
22// HTMLドキュメントの場合、通常、このメソッドは <html> 要素（Dom\Elementのインスタンス）を返します。
23$rootNode = $document->getRootNode();
24
25// 取得したルートノードが存在するか確認し、その情報を出力します。
26if ($rootNode instanceof Dom\Node) {
27    echo "ルートノードが正常に取得されました。\n";
28    echo "ノードのタイプ: " . get_class($rootNode) . "\n"; // 例: Dom\Element
29    echo "ノードの名前 (tagName): " . $rootNode->nodeName . "\n"; // 例: html
30
31    // 一般的なHTMLドキュメントでは、ルートノードは 'html' 要素です。
32    if ($rootNode->nodeName === 'html') {
33        echo "このドキュメントのルートノードは、期待通り 'html' 要素です。\n";
34    }
35} else {
36    // ルートノードが見つからなかった場合（例えば、空のドキュメントの場合など）。
37    echo "ルートノードが見つかりませんでした。\n";
38}
39
40?>

PHP 8のDom\HTMLDocument::getRootNode()メソッドは、HTMLドキュメント全体の最上位要素、つまりルートノードを取得するために使用されます。このメソッドは、HTMLドキュメントをプログラムで操作する際に、その構造の起点となるノードを特定するのに役立ちます。

サンプルコードでは、まずDom\HTMLDocumentのインスタンスを作成し、loadHTML()メソッドでHTMLコンテンツを読み込んでドキュメントオブジェクトを構築しています。これにより、PHP内でHTMLをツリー構造として扱えるようになります。準備が整った後、$document->getRootNode()を呼び出すことで、HTMLドキュメントのルートノードが取得されます。このメソッドは、オプション引数$optionsを受け取りますが、通常は空の配列がデフォルトとして使用されます。

戻り値はDom\Node型のオブジェクト、またはルートノードが見つからない場合にnullとなります。一般的なHTMLドキュメントの場合、このメソッドは<html>要素を表すDom\Elementのインスタンスを返します。取得されたノードが存在するかどうかをinstanceof Dom\Nodeで確認し、そのクラス名やノード名（nodeNameプロパティ）を出力することで、正しくルートノードが取得されたことを確認できます。このメソッドは、HTMLドキュメントの構造を把握し、そこからさらに個別の要素にアクセスするための出発点として非常に重要です。

Dom\HTMLDocument::getRootNode()メソッドは、HTMLドキュメントのルートノードを取得しますが、ドキュメントが適切に読み込まれていない場合や内容が空の場合などにはnullを返す可能性があります。そのため、サンプルコードのようにif ($rootNode instanceof Dom\Node)で、戻り値が有効なノードであるか必ず確認する習慣をつけましょう。

このメソッドを呼び出す前に、必ずloadHTML()メソッドなどでHTMLコンテンツをドキュメントに読み込んでおく必要があります。読み込みが不十分な場合、期待通りのルートノードは取得できません。

HTMLドキュメントにおけるルートノードは、通常<html>要素となり、これはDom\Elementのインスタンスとして扱われます。取得したノードのnodeNameプロパティを確認することで、それが期待する要素であるか検証できます。

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


1<?php
2
3// Dom\HTMLDocument クラスの getRootNode() メソッドの使用例を示します。
4function demonstrateDomHtmlDocumentGetRootNode(): void
5{
6    // サンプルHTML文字列を定義します。
7    $htmlString = '<!DOCTYPE html><html><head><title>Example Page</title></head><body><h1>Hello, PHP DOM!</h1></body></html>';
8
9    // Dom\HTMLDocument オブジェクトを作成し、HTMLをロードします。
10    // PHP 8 の新しい Dom\HTMLDocument クラスを使用します。
11    $document = new Dom\HTMLDocument();
12    $document->loadHTML($htmlString);
13
14    echo "--- Dom\\HTMLDocument::getRootNode() の使用例 ---\n";
15
16    // getRootNode() メソッドを呼び出し、ルートノードを取得します。
17    // 通常、これは Dom\HTMLDocument オブジェクト自身を返します。
18    $rootNode = $document->getRootNode();
19
20    if ($rootNode !== null) {
21        echo "getRootNode() が返したノードのクラス: " . get_class($rootNode) . "\n";
22        echo "getRootNode() が返したノードの名前: '" . $rootNode->nodeName . "'\n"; // 通常 '#document' となります
23        echo "getRootNode() が返したノードのタイプ: " . $rootNode->nodeType . " (DOM_DOCUMENT_NODE)\n";
24
25        // 参考として、HTMLドキュメントの最上位要素（<html>タグ）も取得できます。
26        // これは documentElement プロパティでアクセスします。
27        echo "\n--- 参考: documentElement プロパティ (<html>タグ) ---\n";
28        if ($document->documentElement !== null) {
29            echo "documentElement のノードのクラス: " . get_class($document->documentElement) . "\n";
30            echo "documentElement のノードの名前: '" . $document->documentElement->nodeName . "'\n"; // 通常 'html' となります
31            echo "documentElement のノードのタイプ: " . $document->documentElement->nodeType . " (DOM_ELEMENT_NODE)\n";
32        } else {
33            echo "documentElement が見つかりませんでした。\n";
34        }
35    } else {
36        echo "getRootNode() は null を返しました。\n";
37    }
38}
39
40// 関数を実行します。
41demonstrateDomHtmlDocumentGetRootNode();
42
43?>

Dom\HTMLDocument::getRootNode()メソッドは、HTMLドキュメントオブジェクトの最も根源となるノードを取得するために使用されます。これはDOMツリーにおいて最上位に位置するドキュメントノード（文書そのもの）を指します。引数$optionsはオプションですが、現時点では通常空の配列を指定します。成功した場合、Dom\Nodeオブジェクトを返しますが、これは多くの場合、ドキュメント全体を表すDom\HTMLDocumentオブジェクト自身です。何らかの理由でノードを取得できなかった場合はnullを返します。

サンプルコードでは、まずHTML文字列からDom\HTMLDocumentオブジェクトを作成し、loadHTMLで内容を読み込んでいます。その後getRootNode()を呼び出すと、返されるノードは#documentという名前を持ち、そのクラスはDom\HTMLDocumentであることが確認できます。このルートノードは、HTML文書全体のコンテナであり、実際にコンテンツを持つ<html>要素（documentElementプロパティでアクセス可能）とは異なる最上位の概念です。このメソッドを利用することで、DOMツリーの起点となるノードを正確に把握することができます。

getRootNode()メソッドは、HTMLドキュメントそのものを指すノードを返します。これはドキュメントのルート（#document）であり、<html>タグを指すdocumentElementプロパティとは異なる点にご注意ください。戻り値はnullになる可能性もあるため、利用する際は必ずその確認が必要です。引数は通常、空の配列を指定すれば問題ありません。このメソッドはPHP 8で新しく導入されたDom\HTMLDocumentクラスの機能です。