いっしー@Webエンジニア
Webツールプログラミング言語プログラミング学習ITニュースIT用語辞典ポートフォリオ
Webエンジニア向けプログラミング解説動画をYouTubeで配信中！
▶ チャンネル登録はこちら

【PHP8.x】Dom\HTMLElement::nextSiblingプロパティの使い方

nextSiblingプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

nextSiblingプロパティは、HTMLやXML文書の構造を操作するためのDom\HTMLElementオブジェクトにおいて、現在の要素の「次の兄弟ノード」を保持するプロパティです。HTMLなどのウェブ文書は、要素が親子関係や兄弟関係を持つツリー構造で構成されており、このツリー構造において同じ親を持つ要素同士が兄弟関係にあります。

このプロパティを使用すると、現在のHTML要素の直後に位置する兄弟ノードにプログラムからアクセスできます。例えば、あるdiv要素から始めて、そのdiv要素の次に続く別のp要素やspan要素といったHTML要素、あるいはテキストノードやコメントノードなど、あらゆる種類の兄弟ノードを取得したい場合に役立ちます。

nextSiblingプロパティが返す値は、次の兄弟ノードが存在する場合はDom\Nodeオブジェクトです。このDom\Nodeオブジェクトは、要素ノード（Dom\Element）、テキストノード（Dom\Text）、コメントノード（Dom\Comment）など、さまざまな種類のノードを指す可能性があります。もし次の兄弟ノードが存在しない場合、例えば現在の要素が親の最後の子要素である場合は、nullが返されます。

したがって、このプロパティを利用する際は、返されるノードが期待する要素ノードであるかどうかを判断するために、ノードのタイプを確認する処理が必要になることがあります。これは、HTMLソース上では見えない改行やインデントのための空白文字もテキストノードとして扱われる場合があるためです。ウェブページのDOM構造を探索したり、特定の要素の兄弟要素を順番に処理したりする際に非常に有用なプロパティです。

構文(syntax)

1<?php
2
3$document = new Dom\HTMLDocument();
4$document->loadHTML('<div><span>最初の要素</span><span>次の要素</span></div>');
5
6// 最初の <span> 要素を取得します
7// これは Dom\HTMLElement のインスタンスとなります
8$firstSpan = $document->getElementsByTagName('span')->item(0);
9
10if ($firstSpan instanceof Dom\HTMLElement) {
11    // 現在の要素 ($firstSpan) の次の兄弟要素を取得します
12    // nextSibling プロパティは Dom\Node またはそのサブクラスを返します
13    $nextSiblingNode = $firstSpan->nextSibling;
14
15    // 取得した兄弟要素が Dom\HTMLElement であれば、そのテキストコンテンツを表示します
16    if ($nextSiblingNode instanceof Dom\HTMLElement) {
17        echo $nextSiblingNode->textContent; // 出力: 次の要素
18    }
19}
20
21?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?Dom\Node

このプロパティは、現在の要素の兄弟ノードのうち、直後に位置するノード、または null を返します。

サンプルコード

PHP DOMDocument nextSiblingで次の要素を取得する

1<?php
2
3/**
4 * Dom\HTMLElement::nextSibling プロパティの動作をデモンストレーションする関数。
5 * システムエンジニアを目指す初心者向けに、HTML要素とその次の兄弟ノードの関係を説明します。
6 */
7function demonstrateNextSibling(): void
8{
9    // 1. Dom\HTMLDocument を作成し、サンプルHTMLをロードします。
10    // Dom\HTMLDocument はHTML5互換のDOM操作を提供し、
11    // 内部的に Dom\HTMLElement オブジェクトを扱います。
12    $doc = new Dom\HTMLDocument();
13
14    // デモンストレーション用のHTMLコンテンツ
15    $htmlContent = <<<'HTML'
16    <!DOCTYPE html>
17    <html>
18    <body>
19        <div id="container">
20            <p id="firstElement">最初の段落要素です。</p>
21            <!-- これはコメントノードです -->
22            <p id="secondElement">次の段落要素です。</p>
23            <span>これはスパン要素です。</span>
24            <!-- HTMLソース上の改行や空白もテキストノードとして扱われることがあります -->
25            テキストノードです。
26        </div>
27    </body>
28    </html>
29    HTML;
30
31    // HTMLコンテンツをパースしてDOMツリーを構築します
32    $doc->loadHTML($htmlContent);
33
34    echo "--- Dom\HTMLElement::nextSibling のデモンストレーション ---\n\n";
35
36    // 2. 操作対象となる Dom\HTMLElement を取得します。
37    // getElementById() メソッドは、指定されたIDを持つ要素を返します。
38    // 返されるオブジェクトは Dom\Element (Dom\HTMLElementの親クラス) ですが、
39    // HTML要素であれば Dom\HTMLElement として扱えます。
40    $targetElement = $doc->getElementById('firstElement');
41
42    if ($targetElement instanceof Dom\HTMLElement) {
43        echo "対象要素: <{$targetElement->nodeName}> (ID: '{$targetElement->id}')\n";
44        echo "  内容: '{$targetElement->textContent}'\n\n";
45
46        // 3. nextSibling プロパティを使って次の兄弟ノードを取得します。
47        // nextSibling は、要素、テキスト、コメントなど、あらゆる種類のノードを返します。
48        // 戻り値は ?Dom\Node なので、null の可能性も考慮します。
49        $nextSiblingNode = $targetElement->nextSibling;
50
51        if ($nextSiblingNode !== null) {
52            echo "対象要素の 'nextSibling' ノードが見つかりました。\n";
53            echo "  ノードの種類: ";
54
55            // ノードタイプに応じて情報を表示します。
56            // Dom\Node クラスには、ノードの種類を示す定数が定義されています。
57            switch ($nextSiblingNode->nodeType) {
58                case Dom\Node::ELEMENT_NODE:
59                    echo "要素ノード (<{$nextSiblingNode->nodeName}>)\n";
60                    echo "  ノード内容 (textContent): '{$nextSiblingNode->textContent}'\n";
61                    // もし次の兄弟がHTMLElementであれば、そのIDも表示
62                    if ($nextSiblingNode instanceof Dom\HTMLElement) {
63                        echo "  HTML ID (もしあれば): '{$nextSiblingNode->id}'\n";
64                    }
65                    break;
66                case Dom\Node::TEXT_NODE:
67                    echo "テキストノード\n";
68                    // テキストノードの内容を表示。前後の空白をトリムして見やすくします。
69                    echo "  ノード内容: '" . trim($nextSiblingNode->nodeValue) . "'\n";
70                    break;
71                case Dom\Node::COMMENT_NODE:
72                    echo "コメントノード\n";
73                    echo "  ノード内容: '{$nextSiblingNode->nodeValue}'\n";
74                    break;
75                default:
76                    echo "その他のノード (タイプ: {$nextSiblingNode->nodeType})\n";
77                    echo "  ノード内容: '{$nextSiblingNode->nodeValue}'\n";
78                    break;
79            }
80            echo "\n";
81
82            // さらに、その次の兄弟ノードも確認してみます。
83            // ここでは1つ前の $nextSiblingNode の nextSibling を取得します。
84            $nextNextSiblingNode = $nextSiblingNode->nextSibling;
85
86            if ($nextNextSiblingNode !== null) {
87                echo "さらにその次の 'nextSibling' ノードが見つかりました。\n";
88                echo "  ノードの種類: ";
89                switch ($nextNextSiblingNode->nodeType) {
90                    case Dom\Node::ELEMENT_NODE:
91                        echo "要素ノード (<{$nextNextSiblingNode->nodeName}>)\n";
92                        echo "  ノード内容 (textContent): '{$nextNextSiblingNode->textContent}'\n";
93                        if ($nextNextSiblingNode instanceof Dom\HTMLElement) {
94                            echo "  HTML ID (もしあれば): '{$nextNextSiblingNode->id}'\n";
95                        }
96                        break;
97                    case Dom\Node::TEXT_NODE:
98                        echo "テキストノード\n";
99                        echo "  ノード内容: '" . trim($nextNextSiblingNode->nodeValue) . "'\n";
100                        break;
101                    case Dom\Node::COMMENT_NODE:
102                        echo "コメントノード\n";
103                        echo "  ノード内容: '{$nextNextSiblingNode->nodeValue}'\n";
104                        break;
105                    default:
106                        echo "その他のノード (タイプ: {$nextNextSiblingNode->nodeType})\n";
107                        echo "  ノード内容: '{$nextNextSiblingNode->nodeValue}'\n";
108                        break;
109                }
110            } else {
111                echo "その次の兄弟ノードは見つかりませんでした。\n";
112            }
113
114        } else {
115            echo "対象要素に次の兄弟ノードは見つかりませんでした。\n";
116        }
117    } else {
118        echo "指定されたID 'firstElement' の要素が見つからないか、"
119             . "または HTML 要素ではありませんでした。\n";
120    }
121}
122
123// 関数を実行して、nextSiblingの動作を出力します。
124demonstrateNextSibling();
125
126?>

PHPのDom\HTMLElement::nextSiblingは、HTMLドキュメント内で特定のHTML要素の直後にある「兄弟ノード」を取得するためのプロパティです。ここでいうDom\HTMLElementは、HTMLの<p>や<div>といった具体的な要素を表すオブジェクトを指し、兄弟ノードとは、同じ親要素の下に並ぶ隣接するノードのことです。

このプロパティは引数を取りません。戻り値は?Dom\Node型で、これは次の兄弟ノードが存在すればDom\Nodeオブジェクトを返し、存在しなければnullを返すことを意味します。特に重要な点として、nextSiblingは要素ノードだけでなく、HTMLソースに記述されたコメントノードや、改行・空白によって生成されるテキストノードなども含め、あらゆる種類のノードを対象として次の兄弟を取得します。

例えば、サンプルコードでは<p id="firstElement">要素の直後にあるコメントノードを最初のnextSiblingとして取得し、さらにその次の兄弟として<p id="secondElement">要素を取得していることが示されています。このように、あるHTML要素の次に何があるかを厳密に調べたい場合に大変有効で、HTMLドキュメントの構造を詳細にたどり、要素間の関係をプログラムから操作するための基本的なツールとして、システム開発において広く利用されます。

Dom\HTMLElement::nextSiblingは、次のHTML要素だけでなく、コメントや、HTMLソース上の改行・空白なども「テキストノード」として返すため注意が必要です。このプロパティを利用する際は、間に意図しないテキストノードやコメントノードが挟まっている可能性があることを考慮してください。戻り値はnullの可能性があるため、必ずノードが存在するかチェックし、取得したノードの種類をnodeTypeプロパティやinstanceof演算子で確認してから操作することが、予期せぬエラーを防ぐ上で非常に重要です。要素だけを対象としたい場合は、nextElementSiblingプロパティの利用も検討すると良いでしょう。

PHP DOM: nextSiblingで次の兄弟ノードを取得する

1<?php
2
3/**
4 * PHP DOM拡張 (Dom\HTMLElement::nextSibling) の動作をデモンストレーションします。
5 * nextSibling プロパティは、現在の要素の次の兄弟ノードを返します。
6 * 兄弟ノードには、要素ノード、テキストノード、コメントノードなどが含まれます。
7 * 次の兄弟ノードが存在しない場合は null を返します。
8 */
9function demonstrateNextSiblingProperty(): void
10{
11    // 処理するHTMLコンテンツを定義します。
12    // さまざまなタイプの兄弟ノードを含めています。
13    $htmlContent = <<<HTML
14    <!DOCTYPE html>
15    <html>
16    <body>
17        <div id="container">
18            <p id="firstElement">最初の要素です。</p>
19            これは p タグの次のテキストノードです。
20            <span id="secondElement">二番目の要素です。</span>
21            <!-- これは span タグの次のコメントノードです -->
22            <a id="thirdElement" href="#">三番目の要素です。</a>
23            <!-- 最後の要素の後に続くコメントノード -->
24        </div>
25    </body>
26    </html>
27    HTML;
28
29    // Dom\HTMLDocument オブジェクトを作成し、HTMLコンテンツをロードします。
30    $document = new Dom\HTMLDocument();
31    $document->loadHTML($htmlContent);
32
33    echo "--- Dom\\HTMLElement::nextSibling プロパティのデモンストレーション ---\n\n";
34
35    // 1. IDが 'firstElement' の要素を取得し、その次の兄弟ノードを調べます。
36    // 期待される次の兄弟ノード: テキストノード
37    $firstElement = $document->getElementById('firstElement');
38
39    if ($firstElement instanceof Dom\HTMLElement) {
40        echo "■ ID 'firstElement' (<p>タグ) の次の兄弟ノード:\n";
41        // nextSibling は Dom\Node オブジェクトまたは null を返します。
42        $next = $firstElement->nextSibling;
43
44        if ($next !== null) {
45            echo "  ノードが見つかりました。\n";
46            echo "  ノードタイプ: " . $next->nodeName . " (定数: " . getNodeTypeName($next->nodeType) . ")\n";
47            if ($next->nodeType === Dom\Node::TEXT_NODE) {
48                // テキストノードの場合、値（テキスト）を表示します。
49                echo "  ノード値: '" . trim($next->nodeValue) . "'\n";
50            } elseif ($next->nodeType === Dom\Node::ELEMENT_NODE) {
51                // 要素ノードの場合、タグ名を表示します。
52                echo "  タグ名: " . $next->nodeName . "\n";
53            } elseif ($next->nodeType === Dom\Node::COMMENT_NODE) {
54                // コメントノードの場合、コメント内容を表示します。
55                echo "  コメント内容: " . $next->nodeValue . "\n";
56            }
57        } else {
58            echo "  次の兄弟ノードはありません。\n";
59        }
60    } else {
61        echo "  ID 'firstElement' を持つ要素が見つかりませんでした。\n";
62    }
63
64    echo "\n----------------------------------------\n\n";
65
66    // 2. IDが 'secondElement' の要素を取得し、その次の兄弟ノードを調べます。
67    // 期待される次の兄弟ノード: コメントノード
68    $secondElement = $document->getElementById('secondElement');
69
70    if ($secondElement instanceof Dom\HTMLElement) {
71        echo "■ ID 'secondElement' (<span>タグ) の次の兄弟ノード:\n";
72        $next = $secondElement->nextSibling;
73
74        if ($next !== null) {
75            echo "  ノードが見つかりました。\n";
76            echo "  ノードタイプ: " . $next->nodeName . " (定数: " . getNodeTypeName($next->nodeType) . ")\n";
77            if ($next->nodeType === Dom\Node::TEXT_NODE) {
78                echo "  ノード値: '" . trim($next->nodeValue) . "'\n";
79            } elseif ($next->nodeType === Dom\Node::ELEMENT_NODE) {
80                echo "  タグ名: " . $next->nodeName . "\n";
81            } elseif ($next->nodeType === Dom\Node::COMMENT_NODE) {
82                echo "  コメント内容: " . $next->nodeValue . "\n";
83            }
84        } else {
85            echo "  次の兄弟ノードはありません。\n";
86        }
87    } else {
88        echo "  ID 'secondElement' を持つ要素が見つかりませんでした。\n";
89    }
90
91    echo "\n----------------------------------------\n\n";
92
93    // 3. IDが 'thirdElement' の要素を取得し、その次の兄弟ノードを調べます。
94    // 期待される次の兄弟ノード: テキストノード（改行と最後のコメントノード）
95    $thirdElement = $document->getElementById('thirdElement');
96
97    if ($thirdElement instanceof Dom\HTMLElement) {
98        echo "■ ID 'thirdElement' (<a>タグ) の次の兄弟ノード:\n";
99        $next = $thirdElement->nextSibling;
100
101        if ($next !== null) {
102            echo "  ノードが見つかりました。\n";
103            echo "  ノードタイプ: " . $next->nodeName . " (定数: " . getNodeTypeName($next->nodeType) . ")\n";
104            if ($next->nodeType === Dom\Node::TEXT_NODE) {
105                echo "  ノード値: '" . trim($next->nodeValue) . "'\n";
106            } elseif ($next->nodeType === Dom\Node::ELEMENT_NODE) {
107                echo "  タグ名: " . $next->nodeName . "\n";
108            } elseif ($next->nodeType === Dom\Node::COMMENT_NODE) {
109                echo "  コメント内容: " . $next->nodeValue . "\n";
110            }
111        } else {
112            echo "  次の兄弟ノードはありません。（コンテナの閉じタグの前に位置するため、HTML構造によっては null になることもあります）\n";
113        }
114    } else {
115        echo "  ID 'thirdElement' を持つ要素が見つかりませんでした。\n";
116    }
117}
118
119/**
120 * Dom\Node のノードタイプ定数を読みやすい文字列に変換するヘルパー関数。
121 * システムエンジニアを目指す初心者にも理解しやすいよう、定数の意味を追加しています。
122 *
123 * @param int $nodeType Dom\Node::* 定数のいずれか。
124 * @return string ノードタイプを表す文字列。
125 */
126function getNodeTypeName(int $nodeType): string
127{
128    return match ($nodeType) {
129        Dom\Node::ELEMENT_NODE => 'ELEMENT_NODE (要素ノード: HTMLタグなど)',
130        Dom\Node::ATTRIBUTE_NODE => 'ATTRIBUTE_NODE (属性ノード: class="example" など)',
131        Dom\Node::TEXT_NODE => 'TEXT_NODE (テキストノード: 要素内の文字列など)',
132        Dom\Node::CDATA_SECTION_NODE => 'CDATA_SECTION_NODE (CDATAセクションノード)',
133        Dom\Node::ENTITY_REFERENCE_NODE => 'ENTITY_REFERENCE_NODE (実体参照ノード)',
134        Dom\Node::ENTITY_NODE => 'ENTITY_NODE (実体ノード)',
135        Dom\Node::PROCESSING_INSTRUCTION_NODE => 'PROCESSING_INSTRUCTION_NODE (処理命令ノード)',
136        Dom\Node::COMMENT_NODE => 'COMMENT_NODE (コメントノード: <!-- comment -->)',
137        Dom\Node::DOCUMENT_NODE => 'DOCUMENT_NODE (ドキュメントノード: ドキュメント全体)',
138        Dom\Node::DOCUMENT_TYPE_NODE => 'DOCUMENT_TYPE_NODE (ドキュメントタイプノード: <!DOCTYPE html>)',
139        Dom\Node::DOCUMENT_FRAGMENT_NODE => 'DOCUMENT_FRAGMENT_NODE (ドキュメントフラグメントノード)',
140        Dom\Node::NOTATION_NODE => 'NOTATION_NODE (記法ノード)',
141        default => 'UNKNOWN_NODE (不明なノードタイプ)',
142    };
143}
144
145// サンプルコードの実行
146demonstrateNextSiblingProperty();
147

PHP 8 の Dom\HTMLElement::nextSibling プロパティは、WebページのHTML構造をプログラムで操作する際に利用される、非常に便利な機能です。このプロパティは、現在のHTML要素（例えば<p>タグや<span>タグなど）の「すぐ次の兄弟ノード」を取得するために使われます。

HTMLは、要素が親子関係や兄弟関係を持つツリー構造で構成されており、「兄弟ノード」とは同じ親要素を持つ隣接するノードのことを指します。nextSiblingプロパティは、現在の要素の直後に続くノードを返しますが、ここで重要なのは、取得されるのがHTML要素だけでなく、要素間の改行や空白文字といった「テキストノード」、あるいは「コメントノード」も含まれる点です。

サンプルコードでは、<p id="firstElement">タグの次には、その直後のテキスト「これは p タグの次のテキストノードです。」がテキストノードとして取得されることを示しています。また、<span id="secondElement">タグの次には、「<!-- これは span タグの次のコメントノードです -->」というコメントノードが取得される具体的な例が提示されています。

このプロパティは引数を取らず、戻り値として Dom\Node オブジェクト、または次の兄弟ノードが存在しない場合は null を返します。そのため、取得した結果が null でないことを確認し、ノードのタイプ（要素、テキスト、コメントなど）に応じて適切な処理を行うことが、プログラムを記述する上で重要になります。これにより、Webページの複雑な構造の中から、目的のノードを正確にたどって操作することが可能となります。

Dom\HTMLElement::nextSiblingプロパティは、HTML要素の次の兄弟ノードを返しますが、ここでいう兄弟ノードには、HTMLタグだけでなく、改行やスペースといったテキストノード、そしてコメントノードも含まれることに特に注意が必要です。単に次のHTML要素だけが欲しい場合でも、間にテキストノードやコメントノードを挟む可能性があるため、常に取得されるノードのnodeTypeを確認し、目的のノードタイプであるか判別する処理が必須となります。また、次の兄弟ノードが存在しない場合はnullが返されるため、ノードにアクセスする前にnullチェックを必ず行ってください。これにより、予期せぬエラーを防ぎ、安全にコードを利用できます。HTMLソースの改行やインデントが取得されるテキストノードの内容に影響を与える可能性も理解しておきましょう。

関連コンテンツ

関連IT用語

関連プログラミング言語