【PHP8.x】nextSiblingプロパティの使い方

nextSiblingプロパティは、PHPのDOMCommentクラスに属し、現在のコメントノードの直後に位置する次の兄弟ノードを保持するプロパティです。HTMLやXMLのようなドキュメントは、要素やテキスト、コメントなどが階層構造になった「DOMツリー」として表現されます。このツリーにおいて、同じ親ノードを持つノード同士を「兄弟ノード」と呼びます。

このプロパティを利用すると、現在のDOMCommentオブジェクトの直後に存在する兄弟ノードを取得できます。もし次の兄弟ノードが存在する場合、それはDOMNodeクラス（またはその子クラス、例えばDOMElementやDOMText、DOMCommentなど）のオブジェクトとして返されます。これにより、開発者はドキュメントの構造を順に辿り、各ノードの内容や種類を確認するといった処理が可能になります。

もし現在のコメントノードが、その親ノードの最後の子である場合、つまり直後に兄弟ノードが存在しない場合には、このプロパティはnullを返します。そのため、このプロパティを使用する際には、返り値がnullでないことを確認し、返されたノードの型に応じて適切な処理を行うことが重要です。ドキュメントの構造を順に探索し、特定の情報を見つけ出したり、変更を加えたりする際に非常に役立つプロパティです。

Copy
1<?php
2$dom = new DOMDocument();
3$dom->loadHTML('<div>Element Before<!-- This is a comment --><span>Element After</span></div>');
4
5// コメントノードを見つける
6$commentNode = null;
7foreach ($dom->getElementsByTagName('div')->item(0)->childNodes as $node) {
8    if ($node instanceof DOMComment) {
9        $commentNode = $node;
10        break;
11    }
12}
13
14if ($commentNode) {
15    // DOMCommentオブジェクトのnextSiblingプロパティにアクセスする
16    $nextSibling = $commentNode->nextSibling;
17
18    if ($nextSibling) {
19        echo "コメントの次の兄弟ノードは '" . $nextSibling->nodeName . "' (タイプ: " . $nextSibling->nodeType . ") です。\n";
20        echo "ノードの値: '" . $nextSibling->nodeValue . "'\n";
21    } else {
22        echo "コメントに次の兄弟ノードはありません。\n";
23    }
24} else {
25    echo "HTML内にコメントノードが見つかりませんでした。\n";
26}
27?>

引数なし

引数はありません

DOMNode|null

DOMCommentノードの次の兄弟ノードをDOMNodeオブジェクトとして返します。次の兄弟ノードが存在しない場合はnullを返します。