【PHP8.x】Dom\HTMLDocument::nextSiblingプロパティの使い方
nextSiblingプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
nextSiblingプロパティは、現在操作しているノードの直後に位置する兄弟ノードを保持するプロパティです。
PHPのDom拡張は、HTMLやXMLドキュメントの構造をプログラムから操作するための機能を提供します。この拡張において、ウェブページの要素やテキスト、コメントなどはそれぞれ「ノード」として扱われ、全体として木のような階層構造（DOMツリー）を形成します。この階層において、同じ親ノードを持つノード同士は「兄弟ノード」と呼ばれます。
Dom\HTMLDocumentクラスは、HTMLドキュメント全体、つまりウェブページの内容全体を表す最上位のノードです。このnextSiblingプロパティは、Dom\HTMLDocumentインスタンスが持つ場合、そのドキュメントノードの直後に位置する別の兄弟ノードを参照しようとします。
しかし、一般的なHTMLドキュメントの構造において、ドキュメントノード自体が他のノードの兄弟を持つことは非常に稀です。通常、HTMLドキュメントはウェブページのルートとして存在し、その直後に別のノードが続くことはほとんど想定されません。そのため、Dom\HTMLDocumentオブジェクトに対してこのプロパティを参照しても、ほとんどの場合、値はnullとなります。
このプロパティは、主にHTML要素（例えば<div>タグや<p>タグなど）やテキストノードといった、より具体的なノードに対して、隣接する要素を探索する際に利用されることが一般的です。Dom\HTMLDocumentクラスにこのプロパティが存在するのは、DOMツリー内のすべてのノードが共通して持つ基本的な特性の一つとして定義されているためです。
構文(syntax)
1<?php 2$document = new Dom\HTMLDocument(); 3$nextSiblingNode = $document->nextSibling; // Dom\HTMLDocumentオブジェクトのnextSiblingプロパティは常にnullです。 4?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
?Dom\Node
現在のノードの直後にある兄弟ノードを返します。兄弟ノードが存在しない場合は null を返します。
サンプルコード
PHP DomDocument nextSiblingで兄弟ノードを取得する
1<?php 2 3/** 4 * Dom\HTMLDocument クラスの nextSibling プロパティの動作を示すサンプルコード。 5 * 6 * nextSibling プロパティは、現在のノードの次の兄弟ノードを返します。 7 * これは、要素ノードだけでなく、テキストノードやコメントノードなども兄弟ノードとして取得します。 8 * 兄弟ノードが存在しない場合は null を返します。 9 */ 10function demonstrateHtmlDocumentNextSibling(): void 11{ 12 // HTML文字列を準備します。 13 // P要素とSPAN要素の間にテキストノードが意図的に含まれています。 14 $html = <<<HTML 15<!DOCTYPE html> 16<html> 17<head> 18 <title>PHP Dom\\HTMLDocument::nextSibling Example</title> 19</head> 20<body> 21 <div id="container"> 22 <!-- これはコメントノードです --> 23 <p id="first-paragraph">最初の段落です。</p> 24 次のノードはテキストノードです。 25 <span id="middle-span">これはスパン要素です。</span> 26 <p id="last-paragraph">最後の段落です。</p> 27 </div> 28</body> 29</html> 30HTML; 31 32 // Dom\HTMLDocument のインスタンスを作成します。 33 $document = new Dom\HTMLDocument(); 34 35 // 準備したHTML文字列をドキュメントに読み込みます。 36 $document->loadHTML($html); 37 38 // ID 'first-paragraph' を持つ <p> 要素を取得します。 39 // この要素の次の兄弟ノードを探します。 40 $node = $document->getElementById('first-paragraph'); 41 42 if ($node) { 43 echo "基準となる要素: <" . $node->nodeName . " id=\"" . $node->getAttribute('id') . "\">\n"; 44 45 // nextSibling プロパティを使って、現在のノードの次の兄弟ノードを取得します。 46 // 戻り値は ?Dom\Node なので、null の可能性を考慮してチェックします。 47 $nextSibling = $node->nextSibling; 48 49 if ($nextSibling) { 50 echo " 次の兄弟ノードが見つかりました。\n"; 51 echo " - ノードタイプ (nodeType): " . $nextSibling->nodeType . " (XML_TEXT_NODE は " . XML_TEXT_NODE . ")\n"; 52 echo " - ノード名 (nodeName): " . $nextSibling->nodeName . "\n"; 53 // テキストノードの場合、nodeValue にその内容が含まれます。 54 echo " - ノード値 (nodeValue): '" . trim($nextSibling->nodeValue) . "'\n"; 55 56 // さらに、取得したテキストノードの次の兄弟ノードを取得してみます。 57 // このケースでは <span id="middle-span"> 要素が取得されるはずです。 58 $nextSiblingOfText = $nextSibling->nextSibling; 59 60 if ($nextSiblingOfText) { 61 echo "\n テキストノードの次の兄弟ノードが見つかりました。\n"; 62 echo " - ノードタイプ (nodeType): " . $nextSiblingOfText->nodeType . " (XML_ELEMENT_NODE は " . XML_ELEMENT_NODE . ")\n"; 63 echo " - ノード名 (nodeName): " . $nextSiblingOfText->nodeName . "\n"; 64 65 // ノードが要素ノード (Dom\Element) の場合、tagName や属性にアクセスできます。 66 if ($nextSiblingOfText instanceof Dom\Element) { 67 echo " - タグ名 (tagName): " . $nextSiblingOfText->tagName . "\n"; 68 echo " - ID (getAttribute('id')): " . $nextSiblingOfText->getAttribute('id') . "\n"; 69 } 70 } else { 71 echo "\n テキストノードの次の兄弟ノードは見つかりませんでした。\n"; 72 } 73 } else { 74 echo " 次の兄弟ノードは見つかりませんでした。\n"; 75 } 76 } else { 77 echo "ID 'first-paragraph' を持つ要素が見つかりませんでした。\n"; 78 } 79} 80 81// 定義した関数を実行し、Dom\HTMLDocument::nextSibling の動作を確認します。 82demonstrateHtmlDocumentNextSibling(); 83
PHP 8のDom\HTMLDocumentクラスにあるnextSiblingプロパティは、WebページのHTML構造を操作する際に、現在のノードの「次の兄弟ノード」を取得するために利用されます。兄弟ノードとは、同じ親要素を持つノードのことを指し、HTML要素だけでなく、テキストノードやコメントノードなども含まれます。このプロパティは引数を取りません。戻り値は?Dom\Node型で、次の兄弟ノードが存在すればDom\Nodeオブジェクトを返し、存在しない場合はnullを返します。
サンプルコードでは、まずHTMLドキュメントが読み込まれ、特定の<p>要素（id="first-paragraph"）が基準ノードとして選択されます。この<p>要素のnextSiblingプロパティを参照すると、その直後に位置する「次のノードはテキストノードです。」というテキストコンテンツを含むDom\Textオブジェクトが取得されることが示されます。さらに、このテキストノードから再度nextSiblingプロパティを使うと、その次の兄弟である<span>要素（id="middle-span"）がDom\Elementオブジェクトとして取得されます。このように、nextSiblingプロパティは、ドキュメントツリー内で兄弟ノードを順に辿る際に、要素の種類を問わず次のノードを取得できるため、HTML構造の走査に非常に役立ちます。
nextSiblingプロパティは、HTMLソースコード上の改行や空白文字も含めて、要素ノードだけでなくテキストノードやコメントノードも兄弟ノードとして取得することに注意が必要です。目的の要素ノードが直接取得できない場合、間にテキストノードが存在していないか確認してください。戻り値はノードが存在しない場合にnullとなるため、常にnullチェックを行い、安全に処理を進めることが重要です。取得したノードがテキストノードの場合はnodeValueプロパティで内容を取得し、不要な空白を除去するためにtrim()関数を利用すると良いでしょう。また、要素ノードとして固有の処理を行う際は、instanceof Dom\Elementなどで型をチェックし、安全にプロパティやメソッドにアクセスしてください。
PHP DOM nextSiblingで次の兄弟ノードを取得する
1<?php 2 3/** 4 * Dom\HTMLDocument::nextSibling プロパティの使用例を示す関数。 5 * 6 * PHPのDOM拡張において、Dom\HTMLDocument クラスは Dom\Node を継承しているため 7 * nextSibling プロパティを持ちます。しかし、Dom\HTMLDocument はDOMツリーのルートノードであり、 8 * それ自身には通常兄弟ノードが存在しないため、nextSibling は常に null を返します。 9 * 10 * このサンプルコードでは、より実践的な使い方として、HTMLドキュメント内の一般的な要素（Dom\Element）が持つ 11 * nextSibling プロパティを使用して、その要素の「次の兄弟ノード」を取得する方法を示します。 12 * 13 * nextSibling は、要素だけでなく、テキストノード（HTMLの改行やインデントなども含む）や 14 * コメントノードも兄弟ノードとして返します。 15 * もし「次の兄弟要素（Dom\Element）」のみを明示的に取得したい場合は、nextElementSibling プロパティの使用を検討してください。 16 */ 17function demonstrateNextSibling(): void 18{ 19 // Dom\HTMLDocument の新しいインスタンスを作成します。 20 $document = new Dom\HTMLDocument(); 21 22 // 読み込むHTML文字列を定義します。 23 // 要素の間に改行やスペースがある場合、それらが個別の「テキストノード」として扱われる点に注意してください。 24 $html = <<<HTML 25<div id="parent"> 26 <p id="first-paragraph">最初の段落です。</p> 27 <!-- これはコメントノードです --> 28 <p id="second-paragraph">2番目の段落です。</p> 29 <span>これはスパン要素です。</span> 30</div> 31HTML; 32 33 // HTMLをドキュメントにロードします。 34 // loadHTML() は、不足している doctype や html, head, body タグを自動的に追加する場合があります。 35 $document->loadHTML($html); 36 37 echo "--- nextSibling プロパティの動作例 --- \n\n"; 38 39 // ID 'first-paragraph' を持つ要素を取得します。 40 // この要素の次の兄弟ノードを調べてみます。 41 $node = $document->getElementById('first-paragraph'); 42 43 if ($node === null) { 44 echo "エラー: 'first-paragraph' というIDの要素が見つかりませんでした。\n"; 45 return; 46 } 47 48 echo "現在の対象ノード: <" . $node->nodeName . "> (ID: " . $node->getAttribute('id') . ")\n"; 49 50 // nextSibling プロパティを使って次の兄弟ノードを取得します。 51 // PHP 8 の型ヒントでは ?Dom\Node と定義されており、Dom\Node または null を返します。 52 $nextSibling = $node->nextSibling; 53 54 if ($nextSibling !== null) { 55 echo " [結果] 次の兄弟ノードが見つかりました。\n"; 56 echo " ノード名: " . $nextSibling->nodeName . "\n"; 57 echo " ノードタイプ: " . $nextSibling->nodeType . " ("; 58 switch ($nextSibling->nodeType) { 59 case XML_ELEMENT_NODE: 60 echo "要素ノード"; 61 break; 62 case XML_TEXT_NODE: 63 echo "テキストノード (HTMLの改行や空白など)"; 64 break; 65 case XML_COMMENT_NODE: 66 echo "コメントノード"; 67 break; 68 default: 69 echo "その他のノード (タイプコード: " . $nextSibling->nodeType . ")"; 70 break; 71 } 72 echo ")\n"; 73 74 // テキストノードやコメントノードの場合、nodeValue プロパティに内容が含まれます。 75 if ($nextSibling->nodeValue !== null && trim($nextSibling->nodeValue) !== '') { 76 echo " ノード値 (一部): \"" . substr(trim($nextSibling->nodeValue), 0, 50) . (strlen(trim($nextSibling->nodeValue)) > 50 ? "..." : "") . "\"\n"; 77 } else { 78 echo " ノード値: (空白またはNULL)\n"; 79 } 80 } else { 81 echo " [結果] 現在の対象ノードには次の兄弟ノードがありません。\n"; 82 } 83 84 echo "\n----------------------------------------\n\n"; 85 86 // 別の例: 上記で取得した兄弟ノード（テキストノード）の次の兄弟ノードを調べてみましょう。 87 // 最初の段落の次のノードは、改行とスペースを含むテキストノードです。 88 // そのテキストノードの次の兄弟ノードはコメントノードになるはずです。 89 $commentNode = ($nextSibling !== null) ? $nextSibling->nextSibling : null; 90 91 if ($commentNode !== null) { 92 echo "現在の対象ノード: " . $commentNode->nodeName . " (これはコメントノードです)\n"; 93 echo "ノード値 (一部): \"" . substr(trim($commentNode->nodeValue), 0, 50) . (strlen(trim($commentNode->nodeValue)) > 50 ? "..." : "") . "\"\n"; 94 95 $nextSiblingOfComment = $commentNode->nextSibling; 96 97 if ($nextSiblingOfComment !== null) { 98 echo " [結果] コメントノードの次の兄弟ノードが見つかりました。\n"; 99 echo " ノード名: " . $nextSiblingOfComment->nodeName . "\n"; 100 echo " ノードタイプ: " . $nextSiblingOfComment->nodeType . " ("; 101 switch ($nextSiblingOfComment->nodeType) { 102 case XML_ELEMENT_NODE: 103 echo "要素ノード"; 104 break; 105 case XML_TEXT_NODE: 106 echo "テキストノード (改行や空白など)"; 107 break; 108 case XML_COMMENT_NODE: 109 echo "コメントノード"; 110 break; 111 default: 112 echo "その他のノード (タイプコード: " . $nextSiblingOfComment->nodeType . ")"; 113 break; 114 } 115 echo ")\n"; 116 if ($nextSiblingOfComment->nodeValue !== null && trim($nextSiblingOfComment->nodeValue) !== '') { 117 echo " ノード値 (一部): \"" . substr(trim($nextSiblingOfComment->nodeValue), 0, 50) . (strlen(trim($nextSiblingOfComment->nodeValue)) > 50 ? "..." : "") . "\"\n"; 118 } else { 119 echo " ノード値: (空白またはNULL)\n"; 120 } 121 } else { 122 echo " [結果] コメントノードには次の兄弟ノードがありません。\n"; 123 } 124 } else { 125 echo "エラー: 最初の段落の次のテキストノード、またはその次のコメントノードが見つかりませんでした。\n"; 126 } 127} 128 129// 関数を実行してサンプルコードの動作を確認します。 130demonstrateNextSibling();
PHPのDom\HTMLDocument::nextSiblingプロパティは、Dom\Nodeクラスから継承されるプロパティで、そのノードの直後にある「次の兄弟ノード」を取得するために使用されます。戻り値は?Dom\Node型で、次の兄弟ノードが存在しない場合はnullが返されます。
Dom\HTMLDocumentクラス自体はHTMLドキュメント全体のルートを表すため、通常は兄弟ノードを持ちません。したがって、Dom\HTMLDocumentインスタンスでnextSiblingプロパティを使用しても、常にnullが返されるのが一般的です。
このプロパティが真価を発揮するのは、HTMLドキュメント内の特定の要素（Dom\Elementなど）に対して使用する場合です。nextSiblingは、要素ノードだけでなく、HTMLの改行やインデントといったテキストノード、さらにはコメントノードも「兄弟ノード」として認識し、返します。もし、次の兄弟が要素ノードのみであることを明示的に期待する場合は、nextElementSiblingプロパティの使用を検討してください。
サンプルコードでは、HTML文字列を読み込み、特定の段落要素からnextSiblingプロパティを使って次のノードを段階的に調べています。最初の段落の次のノードがテキストノード（改行や空白）として、さらにその次のノードがコメントノードとして取得される様子を確認できます。これにより、nextSiblingがテキストノードやコメントノードも兄弟として扱う挙動が理解できます。
nextSiblingプロパティは、HTML要素だけでなく、HTMLソースコード中の改行やスペースといった「テキストノード」や「コメントノード」も兄弟ノードとして取得します。もし次の「要素ノード」のみを取得したい場合は、nextElementSiblingプロパティを利用するのが一般的で、意図に合致しやすいでしょう。Dom\HTMLDocumentオブジェクト自体はDOMツリーのルートであるため、通常は兄弟ノードを持たず、そのnextSiblingは常にnullを返します。このプロパティの戻り値は?Dom\Nodeと定義されているため、取得した値がnullではないか、必ず確認してから操作を行うようにしてください。HTML文字列をロードするloadHTMLメソッドは、与えられたHTMLに不足している<html>や<body>タグなどを自動的に補完する場合があります。