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

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

作成日: 更新日:

基本的な使い方

Dom\HTMLElementクラスのpreviousElementSiblingプロパティは、現在の要素の直前の兄弟要素(element)を返します。兄弟要素とは、同じ親要素を持つ要素のことです。このプロパティは、現在の要素の直前の要素が要素ノードである場合にのみ、その要素を返します。もし直前の兄弟要素が存在しない場合、または直前の兄弟要素が要素ノードでない場合、このプロパティはnullを返します。

具体的には、HTMLドキュメント内で特定の要素を見つけ、その要素の前にある兄弟要素を取得したい場合に、このプロパティを使用します。例えば、リスト内の特定の項目(<li>要素)を選択し、その直前の項目を取得する、といった操作が可能です。

previousElementSiblingプロパティは読み取り専用であり、値を設定することはできません。このプロパティを利用することで、DOMツリーを効率的にナビゲートし、特定の要素の周辺要素を特定することができます。DOM操作を行う際に、要素間の関係性を把握し、動的にコンテンツを操作する上で重要な役割を果たします。previousElementSiblingプロパティは、JavaScriptにおけるelement.previousElementSiblingプロパティと同様の機能を提供し、PHPでDOMを扱う際の要素操作を容易にします。

構文(syntax)

1Dom\HTMLElement::$previousElementSibling;

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMElement|null

previousElementSibling プロパティは、現在の要素の直前に位置する兄弟要素(同じ親を持つ要素)を DOMElement オブジェクトとして返します。直前の兄弟要素が存在しない場合は null を返します。

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