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

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

作成日: 更新日:

基本的な使い方

previousSiblingプロパティは、DOMNodeオブジェクトにおいて、現在のノードの直前の兄弟ノードを表す読み取り専用のプロパティです。DOM(Document Object Model)は、HTMLやXMLドキュメントをプログラムから操作するためのAPIであり、ノードはドキュメントを構成する要素、属性、テキストなどの個々の部品を指します。

兄弟ノードとは、同じ親ノードを持つノードのことです。例えば、ある要素の中に複数の子要素がある場合、それらの子要素はお互いに兄弟ノードの関係にあります。previousSiblingプロパティを使用することで、DOMツリーを辿り、現在のノードから見て直前の兄弟ノードにアクセスできます。

このプロパティが返す値は、DOMNodeオブジェクト、またはNULLです。直前の兄弟ノードが存在する場合、そのノードを表すDOMNodeオブジェクトが返されます。直前の兄弟ノードが存在しない場合(例えば、現在のノードが親ノードの最初の子ノードである場合)は、NULLが返されます。

previousSiblingプロパティは読み取り専用であるため、このプロパティに値を代入して兄弟ノードを変更することはできません。ノードの追加、削除、挿入などの操作は、別のDOMメソッドを使用する必要があります。

システムエンジニアがDOMを操作する際、previousSiblingプロパティは、特定のノードの文脈における兄弟関係を把握し、効率的にDOMツリーをナビゲートするために非常に重要な役割を果たします。例えば、特定の要素の直前に新しい要素を挿入したり、兄弟要素の属性を比較したりする場合などに利用されます。

構文(syntax)

1DOMNode::$previousSibling;

引数(parameters)

戻り値(return)

DOMNode|null

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