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

【PHP8.x】DOMComment::previousElementSiblingプロパティの使い方

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

作成日: 更新日:

基本的な使い方

previousElementSiblingプロパティは、DOM（Document Object Model）ツリー構造において、現在のノードの直前にある「要素ノード（Element Node）」の兄弟ノードを保持するプロパティです。このプロパティは、HTMLやXML文書の構造を走査する際に、テキストノードやコメントノードといった非要素ノードをスキップし、純粋な要素ノードのみを効率的に取得したい場合に利用されます。例えば、ウェブページで特定のHTML要素に隣接する兄弟要素を操作したいが、その間に含まれる改行や空白文字、コメントなどを無視したい場合に非常に便利です。

しかし、PHPの標準DOM拡張において、DOMCommentクラスはコメントノードを表しており、通常このpreviousElementSiblingプロパティを直接は保持しません。このプロパティは主にDOMElementクラス、すなわちHTMLタグのような要素ノードに定義されています。DOMCommentオブジェクトが持つのは、要素ノードだけでなく、あらゆる種類の直前の兄弟ノード（テキストノードや他のコメントノードなども含む）を返すpreviousSiblingプロパティです。もしDOMCommentオブジェクトの直前にある要素ノード型の兄弟ノードを取得したい場合は、previousSiblingを繰り返し利用し、返されたノードの型がDOMElementであるかを確認する処理が必要になります。このpreviousElementSiblingプロパティは、要素ノードを直接扱う際にその強力な機能を発揮するものです。

構文(syntax)

1<?php
2
3// 解析するHTML文字列を定義
4$html = '
5<div>
6    <p>最初の段落</p>
7    <!-- ここがコメント -->
8    <span>次の要素</span>
9</div>
10';
11
12// DOMDocumentオブジェクトを生成し、HTMLを読み込む
13$doc = new DOMDocument();
14$doc->loadHTML($html, LIBXML_NOERROR);
15
16// XPathを使用してコメントノードを取得
17$xpath = new DOMXPath($doc);
18$comment = $xpath->query('//comment()')->item(0);
19
20// コメントノードの直前の兄弟「要素」を取得する
21// (コメントの直前にある改行や空白などのテキストノードは無視されます)
22$previousElement = $comment->previousElementSibling;
23
24// 取得した要素のタグ名を出力する
25if ($previousElement !== null) {
26    // 出力結果: p
27    echo $previousElement->tagName;
28}
29

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP DOMCommentからpreviousElementSiblingを取得する

1<?php
2
3/**
4 * 指定されたHTMLコンテンツから最初のDOMCommentノードを見つけ、
5 * その直前の要素兄弟ノード（DOMElement）を返します。
6 *
7 * DOMCommentクラスは 'previousElementSibling' プロパティを直接持ちません。
8 * この関数では、DOMCommentの 'previousSibling' プロパティを繰り返し辿り、
9 * 各ノードが要素ノードであるかを確認することで、この概念的な機能を実現しています。
10 *
11 * @param string $html HTMLコンテンツ文字列。
12 * @return DOMElement|null 見つかった直前の要素兄弟ノード、または見つからない場合はnull。
13 */
14function getPreviousElementSiblingOfFirstComment(string $html): ?DOMElement
15{
16    $dom = new DOMDocument();
17    // HTMLのパースエラーを抑制し、後でクリア
18    libxml_use_internal_errors(true);
19    $dom->loadHTML($html);
20    libxml_clear_errors();
21
22    $commentNode = null;
23    $xpath = new DOMXPath($dom);
24    // ドキュメント内のすべてのコメントノードを検索し、最初のものを取得
25    $commentNodes = $xpath->query('//comment()');
26
27    if ($commentNodes->length > 0) {
28        $commentNode = $commentNodes->item(0);
29    } else {
30        echo "HTML内にコメントノードが見つかりませんでした。\n";
31        return null;
32    }
33
34    echo "--- 対象コメントノードの情報 ---\n";
35    echo "ノード値: '" . $commentNode->nodeValue . "'\n";
36    echo "親ノードのタグ名: " . ($commentNode->parentNode ? $commentNode->parentNode->tagName : 'なし') . "\n\n";
37
38    // DOMCommentには 'previousElementSibling' プロパティがないため、
39    // 'previousSibling' を使って直前の兄弟ノードを順に辿ります。
40    $currentSibling = $commentNode->previousSibling;
41
42    while ($currentSibling !== null) {
43        // 現在の兄弟ノードが要素ノード（DOMElement）であるかを確認
44        if ($currentSibling->nodeType === XML_ELEMENT_NODE) {
45            // 要素ノードが見つかった場合、それを返します
46            return $currentSibling;
47        }
48        // 次の前の兄弟ノードへ移動
49        $currentSibling = $currentSibling->previousSibling;
50    }
51
52    // ループが終了し、要素ノードが見つからなかった場合
53    return null;
54}
55
56// サンプルHTML文字列
57$sampleHtml = '
58<!DOCTYPE html>
59<html>
60<body>
61    <header>ヘッダー部</header>
62    <p>最初の段落要素</p>
63    <!-- これはサンプルのコメントです -->
64    <span>次の要素</span>
65    <div>最後の要素</div>
66</body>
67</html>';
68
69// 関数を実行し、結果を取得
70$previousElement = getPreviousElementSiblingOfFirstComment($sampleHtml);
71
72if ($previousElement) {
73    echo "--- 見つかった直前の要素兄弟ノードの情報 ---\n";
74    echo "タグ名: " . $previousElement->tagName . "\n";
75    echo "テキスト内容: '" . trim($previousElement->textContent) . "'\n";
76} else {
77    echo "コメントノードの直前の要素兄弟ノードは見つかりませんでした。\n";
78}
79
80?>

PHPのDOM拡張機能は、HTMLやXML文書の構造をオブジェクトとして扱います。その中のDOMCommentクラスは、HTML内のコメントノード（例: <!-- コメント -->）を表すものです。DOMCommentクラスには、コメントの直前の要素（タグ付き）兄弟ノードを直接取得するpreviousElementSiblingというプロパティは存在しません。

提供されたサンプルコードは、この概念的な「直前の要素兄弟ノード」をPHPで取得する方法を示しています。このコードは、引数として渡されたHTMLコンテンツを解析し、ドキュメント内から最初のコメントノードを見つけます。その後、そのコメントノードからpreviousSiblingプロパティを繰り返し辿り、各兄弟ノードが要素ノード（タグを持つDOMElement）であるかをnodeTypeプロパティで確認し、最初に見つかった要素ノードを返しています。

getPreviousElementSiblingOfFirstComment関数は、HTMLコンテンツ文字列を引数として受け取り、直前の要素兄弟ノードが見つかった場合はDOMElementオブジェクトを、見つからなかった場合はnullを戻り値として返します。これにより、コメントの直前にあるHTML要素をプログラミングによって効率的に特定することが可能になります。

PHPのDOMCommentクラスには、リファレンス情報にあるpreviousElementSiblingプロパティが直接は存在しません。そのため、サンプルコードのようにpreviousSiblingを繰り返し辿り、ノードのnodeTypeがXML_ELEMENT_NODEであるかを確認して直前の要素ノードを探す実装が必要です。previousSiblingはコメントやテキストノードを含むあらゆる兄弟ノードを返しますが、previousElementSiblingは要素ノードのみを対象とします。この両者の違いを理解し、混同しないよう注意しましょう。また、ノードが見つからない場合はnullが返されるため、プロパティにアクセスする前には必ずnullチェックを行い、実行時エラーを防ぐことが大切です。HTML解析時のlibxml_use_internal_errorsはエラーを抑制するだけで、本番運用ではエラーログの確認や適切なエラー処理も検討してください。

PHP DOMElementのpreviousElementSiblingを取得する

1<?php
2
3/**
4 * PHP DOMのpreviousElementSiblingプロパティの使用例を示します。
5 *
6 * リファレンス情報には「所属クラス: DOMComment」「名前: previousElementSibling」とありますが、
7 * PHPのDOMCommentクラスにはpreviousElementSiblingプロパティは存在しません。
8 * previousElementSiblingプロパティはDOMElementクラスに存在し、
9 * その要素の直前の兄弟要素ノードを返します。
10 * これはJavaScriptのElement.previousElementSiblingと同様の機能です。
11 *
12 * @return void
13 */
14function demonstratePreviousElementSibling(): void
15{
16    // サンプルとなるHTML文字列を作成
17    $html = <<<HTML
18<div id="container">
19    <p>要素1</p>
20    <!-- これはコメントノードです -->
21    <span>要素2</span>
22    <p>要素3</p>
23    <!-- 別のコメント -->
24    <div>要素4</div>
25</div>
26HTML;
27
28    $dom = new DOMDocument();
29    // HTMLをパースし、一般的なHTMLの構造に関する警告を抑制します。
30    // LIBXML_HTML_NOIMPLIED: 省略された<html>, <body>タグを追加しない
31    // LIBXML_HTML_NODEFDTD: デフォルトのDTDを追加しない
32    @$dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
33
34    // ID 'container' の要素を取得
35    $container = $dom->getElementById('container');
36
37    if ($container) {
38        echo "=== コンテナの子ノードとそのpreviousElementSiblingの確認 ===\n";
39        // コンテナの子ノードをすべて取得し、それぞれを処理
40        foreach ($container->childNodes as $node) {
41            echo "  - ノードタイプ: " . $node->nodeName;
42
43            if ($node instanceof DOMElement) {
44                // DOMElementの場合、そのテキストコンテンツを表示
45                echo " (DOMElement) - テキスト: \"" . trim($node->textContent) . "\"";
46                // previousElementSiblingプロパティを使って直前の兄弟要素を取得
47                $previousElement = $node->previousElementSibling;
48                if ($previousElement) {
49                    echo " | previousElementSibling: <" . $previousElement->nodeName . "> (テキスト: \"" . trim($previousElement->textContent) . "\")";
50                } else {
51                    echo " | previousElementSibling: (なし)";
52                }
53            } elseif ($node instanceof DOMComment) {
54                // DOMCommentの場合、コメント内容を表示
55                echo " (DOMComment) - コメント: \"" . $node->nodeValue . "\"";
56                // DOMCommentにはpreviousElementSiblingが存在しないことを明示
57                echo " | previousElementSibling: (DOMCommentにはこのプロパティは存在しません)";
58            } elseif ($node instanceof DOMText && trim($node->nodeValue) === '') {
59                // 空白のみのテキストノードはスキップ（整形目的）
60                continue;
61            } else {
62                // その他のノードタイプ
63                echo " (その他)";
64            }
65            echo "\n";
66        }
67
68        echo "\n=== 特定の要素からpreviousElementSiblingを取得する例 ===\n";
69
70        // <span>要素2</span> を取得
71        $spanElement = $dom->getElementsByTagName('span')->item(0);
72
73        if ($spanElement) {
74            echo "  現在の要素: <{$spanElement->nodeName}> \"" . trim($spanElement->textContent) . "\"\n";
75            $prevElem = $spanElement->previousElementSibling;
76            if ($prevElem) {
77                echo "  直前の兄弟要素: <{$prevElem->nodeName}> \"" . trim($prevElem->textContent) . "\"\n"; // 期待値: <p> 要素1
78            } else {
79                echo "  直前の兄弟要素は見つかりませんでした。\n";
80            }
81        }
82
83        echo "\n=== <p>要素3</p> の previousElementSibling を取得する例 ===\n";
84        // 2番目の <p>要素3</p> を取得
85        $p3Element = $dom->getElementsByTagName('p')->item(1);
86
87        if ($p3Element) {
88            echo "  現在の要素: <{$p3Element->nodeName}> \"" . trim($p3Element->textContent) . "\"\n";
89            $prevElemP3 = $p3Element->previousElementSibling;
90            if ($prevElemP3) {
91                echo "  直前の兄弟要素: <{$prevElemP3->nodeName}> \"" . trim($prevElemP3->textContent) . "\"\n"; // 期待値: <span> 要素2
92            } else {
93                echo "  直前の兄弟要素は見つかりませんでした。\n";
94            }
95        }
96    } else {
97        echo "エラー: コンテナ要素が見つかりませんでした。\n";
98    }
99}
100
101// 関数の実行
102demonstratePreviousElementSibling();

PHPのpreviousElementSiblingは、DOM（Document Object Model）ツリーにおいて、現在の要素の直前にある兄弟要素ノードを取得するためのプロパティです。リファレンス情報にはDOMCommentクラスに所属すると記載されていますが、実際にはDOMElementクラスに存在し、その要素の直前の兄弟要素を返します。このプロパティは引数を取らず、戻り値として直前の兄弟要素がDOMElementオブジェクトとして返されます。もし直前の兄弟要素が存在しない場合や、直前の兄弟ノードが要素ノードではない（テキストノードやコメントノードなど）場合はnullを返します。

サンプルコードでは、まずHTML文字列からDOMDocumentを作成し、特定の要素からpreviousElementSiblingプロパティを用いて直前の兄弟要素を探しています。例えば、<span>要素2</span>の直前の兄弟ノードにはコメントノードがありますが、previousElementSiblingは要素ノードのみを対象とするため、このコメントノードは無視され、さらにその前の<p>要素1</p>が直前の兄弟要素として取得されます。同様に、<p>要素3</p>からは<span>要素2</span>が直前の兄弟要素として取得されます。この機能は、JavaScriptのElement.previousElementSiblingと同様に、DOMツリーを操作する際に非常に便利です。

previousElementSiblingは、リファレンス情報にあるDOMCommentクラスではなく、DOMElementクラスにのみ存在するプロパティです。このプロパティは、現在の要素ノードの直前にある兄弟要素ノードを返します。コメントノードや空白などのテキストノードは無視され、純粋な要素ノードのみが対象となります。そのため、DOM構造を扱う際は、対象のノードがDOMElement型であることを確認してから利用するようにしてください。直前の兄弟要素が存在しない場合はnullを返しますので、結果がnullでないかどうかの確認も重要です。これはJavaScriptの同名プロパティと同じ動作をします。

関連コンテンツ

関連IT用語

関連プログラミング言語