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

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

作成日: 更新日:

基本的な使い方

previousSiblingプロパティは、PHPのDOM拡張機能の一部として、HTMLドキュメント内の特定のノードから見て、その直前の兄弟ノードを保持するプロパティです。このプロパティは、Dom\HTMLDocumentクラスを介してアクセスされるHTMLドキュメント内の任意のノード(要素、テキストなど)に適用されます。

WebページなどのHTMLドキュメントは、要素が階層的に配置されたツリー構造(DOMツリー)で構成されています。previousSiblingプロパティを使用すると、現在注目しているノードと同じ階層にあり、かつそのノードのすぐ前に位置するノードを取得できます。例えば、あるHTML要素からその直前の兄弟要素やテキストコンテンツを取得するといった操作が可能です。

このプロパティによって取得されるノードは、HTMLタグで囲まれた要素ノードだけでなく、要素間の空白や改行を含むテキストノード、さらにはコメントノードなども含まれます。もし、現在のノードの直前に兄弟ノードが存在しない場合(例えば、現在のノードが親要素の最初の子ノードである場合)、このプロパティはnullを返します。

previousSiblingプロパティは、DOMツリーを効率的に走査し、HTMLドキュメントの構造を解析したり、特定の要素の前後にあるコンテンツを動的に操作したりする際に非常に便利です。PHP 8環境下でWebコンテンツを扱うシステム開発において、ドキュメントのナビゲーションや情報の抽出に広く活用されます。

構文(syntax)

1<?php
2$document = new DOM\HTMLDocument();
3$previousNode = $document->previousSibling;
4?>

引数(parameters)

戻り値(return)

Dom\Node|null

このプロパティは、現在のノードの直前の兄弟ノードを返します。兄弟ノードが存在しない場合は null を返します。

関連コンテンツ

【PHP8.x】previousSiblingプロパティの使い方 | いっしー@Webエンジニア