Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

nextElementSiblingプロパティは、Dom\Elementオブジェクトにおいて、その要素の次の兄弟要素(同じ親要素を持つ要素)を表すプロパティです。具体的には、DOMツリー上で、現在の要素の直後に位置する要素を指し示します。もし次の兄弟要素が存在しない場合、このプロパティはnullを返します。

このプロパティは読み取り専用であり、値を直接設定することはできません。DOM構造をプログラムから操作する際に、兄弟要素を辿って処理を行う必要がある場合に非常に役立ちます。例えば、特定の要素の後に続く要素の情報を取得したり、特定の条件を満たすまで兄弟要素を順に処理したりするような場合に利用されます。

nextElementSiblingプロパティは、要素の種類(element type)が異なる兄弟要素も対象とします。例えば、現在の要素がテキストノードであったとしても、次の兄弟要素が要素ノードであれば、その要素ノードが返されます。コメントノードやテキストノードを無視して、要素ノードのみを取得したい場合は、ループ処理とnodeTypeプロパティを用いたフィルタリングが必要になります。

このプロパティを利用することで、DOMツリーの構造を効率的にナビゲートし、必要な要素を特定して操作することができます。DOM操作を行う上で、nextElementSiblingプロパティは重要な役割を果たします。

構文(syntax)

1readonly public ?Dom\Element $nextElementSibling

引数(parameters)

引数なし

引数はありません

戻り値(return)

Dom\Element|null

指定されたDom\Elementオブジェクトの直後の兄弟要素を表すDom\Elementオブジェクト、または、直後に兄弟要素が存在しない場合はnullを返します。

サンプルコード

PHP Dom\Element::nextElementSibling で次の要素を取得する

1<?php
2
3/**
4 * Dom\Element::nextElementSibling プロパティの使用例を示します。
5 *
6 * nextElementSibling プロパティは、現在の要素の次の兄弟要素ノードを返します。
7 * HTMLドキュメントにおいて、テキストノードやコメントノードはスキップされ、
8 * 直接次の「要素」ノード(タグで囲まれた部分)のみを対象とします。
9 * 次の兄弟要素ノードが存在しない場合は null を返します。
10 */
11function demonstrateNextElementSibling(): void
12{
13    // HTMLコンテンツを作成します。
14    // nextElementSibling の動作を明確に示すため、
15    // 要素の間にコメントノードやテキストノードを含めます。
16    $html = <<<HTML
17    <div id="container">
18        <p id="first-paragraph">最初の段落です。</p>
19        <!-- これはコメントノードで、スキップされます -->
20        <span>次の兄弟要素です。</span>
21        これはテキストノードで、スキップされます。
22        <em id="last-element">最後の要素です。</em>
23    </div>
24    HTML;
25
26    // DOMドキュメントを初期化し、HTML文字列をロードします。
27    // PHP 8 では Dom\HTMLDocument を使用できます。
28    $document = new Dom\HTMLDocument();
29    $document->loadHTML($html);
30
31    // --- 例1: 次の兄弟要素ノードが存在する場合 ---
32    // ID 'first-paragraph' を持つ <p> 要素を取得します。
33    $paragraphElement = $document->getElementById('first-paragraph');
34
35    // 取得した要素が Dom\Element のインスタンスであることを確認します。
36    if ($paragraphElement instanceof Dom\Element) {
37        echo "--- 例1: 次の兄弟要素ノードが存在する場合 ---\n";
38        echo "現在の要素: <{$paragraphElement->tagName}> (ID: {$paragraphElement->id})\n";
39
40        // nextElementSibling プロパティを使用して、次の兄弟要素ノードを取得します。
41        // この場合、コメントノードとテキストノードはスキップされ、<span>要素が取得されます。
42        $nextSiblingElement = $paragraphElement->nextElementSibling;
43
44        if ($nextSiblingElement !== null) {
45            echo "nextElementSibling で取得した次の兄弟要素ノード: <{$nextSiblingElement->tagName}>\n";
46            echo "そのテキストコンテンツ: '{$nextSiblingElement->textContent}'\n";
47        } else {
48            echo "次の兄弟要素ノードは見つかりませんでした。\n";
49        }
50        echo "\n";
51    } else {
52        echo "例1: 指定されたIDの要素が見つからないか、Dom\\Elementではありません。\n\n";
53    }
54
55
56    // --- 例2: 次の兄弟要素ノードが存在しない場合 ---
57    // ID 'last-element' を持つ <em> 要素を取得します。これはHTMLコンテンツの最後の要素です。
58    $lastElement = $document->getElementById('last-element');
59
60    if ($lastElement instanceof Dom\Element) {
61        echo "--- 例2: 次の兄弟要素ノードが存在しない場合 ---\n";
62        echo "現在の要素: <{$lastElement->tagName}> (ID: {$lastElement->id})\n";
63
64        // nextElementSibling プロパティを使用して、次の兄弟要素ノードを取得します。
65        // この要素には続く要素ノードがないため、null が返されます。
66        $nextSiblingOfLast = $lastElement->nextElementSibling;
67
68        if ($nextSiblingOfLast !== null) {
69            echo "nextElementSibling で取得した次の兄弟要素ノード: <{$nextSiblingOfLast->tagName}>\n";
70            echo "そのテキストコンテンツ: '{$nextSiblingOfLast->textContent}'\n";
71        } else {
72            echo "次の兄弟要素ノードは見つかりませんでした。(期待通り: nullが返されました)\n";
73        }
74    } else {
75        echo "例2: 指定されたIDの要素が見つからないか、Dom\\Elementではありません。\n";
76    }
77}
78
79// 関数を実行して動作を確認します。
80demonstrateNextElementSibling();
81

Dom\Element::nextElementSiblingプロパティは、HTMLなどのDOM(Document Object Model)ドキュメントにおいて、現在選択している要素の直後にある「次の兄弟要素ノード」を取得するために使用されます。このプロパティは引数を取らず、兄弟ノードのうちテキストノードやコメントノードは無視し、直接次のタグで囲まれた要素ノードのみを対象とします。

取得に成功した場合、次の兄弟要素を表すDom\Elementオブジェクトが戻り値として返されます。もし次の兄弟要素ノードが存在しない場合、あるいは間に要素以外のノードしかない場合は、nullが返されます。

サンプルコードでは、まず<p>要素の次の兄弟要素を取得する例を示しています。この際、<p>と次の<span>の間にあるコメントノードやテキストノードはスキップされ、直接<span>要素が取得されることが確認できます。次に、DOMドキュメントの最後の要素である<em>要素に対してこのプロパティを使用すると、後続の要素がないためnullが返される挙動を示しており、プロパティの正確な動作を理解するのに役立ちます。これにより、文書構造をたどって特定の要素を見つけ出す際に、不要なノードを気にすることなく目的の要素にアクセスできます。

Dom\Element::nextElementSiblingは、現在の要素の次の「要素」ノードのみを返します。要素間に存在するテキストノードやコメントノードは自動的にスキップされる点に注意が必要です。単に次の兄弟ノードを取得するnextSiblingとは異なり、HTMLの構造的な要素のみを対象とします。次の兄弟要素ノードが存在しない場合はnullが返されるため、取得した値がnullでないかを必ず確認してから操作を行ってください。このnullチェックを怠ると、プログラム実行時にエラーが発生する原因となります。また、対象の変数がDom\Elementのインスタンスであるかinstanceofで確認する習慣は、コードの安全性を高める上で非常に有効です。PHP 8からはDom\HTMLDocumentクラスを利用して、HTMLのロードとDOM操作をよりシンプルに行うことができます。

Dom\Element::nextElementSibling で次の兄弟要素を取得する

1<?php
2
3/**
4 * Dom\Element::nextElementSibling の使用方法を実演する関数。
5 *
6 * この関数は、指定されたHTML要素の「次の兄弟要素」(Elementノードのみ)を取得する方法を示します。
7 * テキストノードやコメントノードはスキップされ、要素ノードだけが対象となります。
8 * PHP 8以降で導入された Dom 名前空間を使用しています。
9 */
10function demonstrateNextElementSibling(): void
11{
12    // PHP 8+ で利用可能なモダンな Dom\Document オブジェクトを作成
13    $document = new Dom\Document();
14
15    // nextElementSibling の動作を分かりやすく示すためのHTMLコンテンツを読み込む
16    // コメントノードが含まれており、nextElementSiblingがこれをスキップすることを確認できる
17    $html = <<<HTML
18<div id="container">
19    <p id="p1">これは最初の段落です。</p>
20    <span>これはスパン要素です。</span>
21    <p id="p2">これは2番目の段落です。</p>
22    <!-- これはコメントノードです。nextElementSibling はこれをスキップします。-->
23    <span>別のスパン要素です。</span>
24    <p id="p3">これは3番目の段落です。</p>
25</div>
26HTML;
27    $document->loadHtml($html);
28
29    // ID 'p1' を持つ最初の段落要素を取得
30    // querySelector は Dom\Element オブジェクト、または見つからなければ null を返す
31    $firstParagraph = $document->querySelector('#p1');
32
33    if ($firstParagraph instanceof Dom\Element) {
34        echo "ID 'p1' を持つ要素が見つかりました: <" . $firstParagraph->tagName . ">\n";
35
36        // nextElementSibling プロパティを使用して、次の兄弟要素を取得します。
37        // ここでは、<p id="p1"> の次の兄弟要素である <span> が取得されます。
38        // 途中のテキストノードやコメントノードは自動的にスキップされます。
39        $nextElement = $firstParagraph->nextElementSibling;
40
41        if ($nextElement instanceof Dom\Element) {
42            echo "その次の兄弟要素は: <" . $nextElement->tagName . "> (内容の冒頭: '" . substr($nextElement->textContent, 0, 20) . "...')\n";
43
44            // さらにその次の兄弟要素を取得してみる
45            // <span> の次の兄弟要素である <p id="p2"> が取得されます。
46            $anotherNextElement = $nextElement->nextElementSibling;
47            if ($anotherNextElement instanceof Dom\Element) {
48                echo "そのまた次の兄弟要素は: <" . $anotherNextElement->tagName . "> (ID: " . $anotherNextElement->id . ", 内容の冒頭: '" . substr($anotherNextElement->textContent, 0, 20) . "...')\n";
49            } else {
50                echo "次の兄弟要素が見つかりませんでした。\n";
51            }
52
53            // nextElementSibling を使って、特定の要素から末尾まで兄弟要素を順に辿る例
54            echo "\n'p1' から始まる兄弟要素を順に辿ります:\n";
55            $currentElement = $firstParagraph;
56            $index = 1;
57            while ($currentElement instanceof Dom\Element) {
58                echo "  [{$index}] <" . $currentElement->tagName . "> (ID: " . ($currentElement->id ?: 'なし') . ")\n";
59                $currentElement = $currentElement->nextElementSibling; // 次の兄弟要素を取得
60                $index++;
61            }
62            echo "兄弟要素の探索を終了しました。\n";
63
64        } else {
65            echo "ID 'p1' を持つ要素の次の兄弟要素は見つかりませんでした。\n";
66        }
67    } else {
68        echo "ID 'p1' を持つ要素が見つかりませんでした。\n";
69    }
70}
71
72// 関数を実行してデモンストレーションを開始
73demonstrateNextElementSibling();

Dom\Element::nextElementSiblingは、PHP 8で導入されたDOM操作のためのプロパティです。これは、指定されたHTML要素の直後に位置する「次の兄弟要素」を取得するために使用されます。ここでいう「兄弟要素」とは、同じ親要素を持つ要素のことです。

このプロパティの大きな特徴は、テキストノードやコメントノードといった要素ではない兄弟ノードを自動的にスキップし、HTMLタグで構成される要素(Elementノード)だけを対象とすることです。これにより、DOMツリー内で要素だけを効率的に辿ることができます。

引数は不要で、呼び出すだけで使用できます。戻り値は、次の兄弟要素が存在すればDom\Elementオブジェクトを返しますが、存在しない場合はnullを返します。

サンプルコードでは、p1というIDを持つ段落要素からnextElementSiblingを使って次の要素を取得しています。具体的には、<p id="p1">の直後にある<span>要素が取得されます。その後、さらにnextElementSiblingを繰り返し利用することで、コメントノードをスキップして次の段落要素p2を順に辿っていく様子が示されており、このプロパティの挙動を明確に理解できます。HTML構造から特定の要素だけを抜き出して処理したい場合に非常に便利な機能です。

nextElementSiblingは、現在の要素の次の兄弟要素のうち、要素ノードだけを取得するプロパティです。テキストノードやコメントノードは自動的にスキップされるため、要素だけを効率的に辿りたい場合に便利です。この機能はPHP 8以降で導入されたDom名前空間で利用可能です。重要な注意点として、次の兄弟要素が存在しない場合はnullを返します。そのため、サンプルコードのようにif ($element instanceof Dom\Element)を使って、返された値が有効な要素であるか必ず確認してください。この確認を怠ると、プログラムが予期せぬエラーで停止する可能性があります。

関連コンテンツ

関連プログラミング言語