【PHP8.x】Dom\ChildNode::before()メソッドの使い方
beforeメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
beforeメソッドは、DOM (Document Object Model) ツリーにおいて、現在のノードの直前に新しいノードまたはテキストコンテンツを挿入するメソッドです。このメソッドは、Dom\ChildNodeインターフェースを実装するオブジェクト、例えばDom\Element、Dom\CharacterData、Dom\DocumentTypeなどのノードに対して利用できます。
具体的には、現在のノードの親ノードの子要素リストの中で、現在のノードよりも前に指定されたコンテンツを追加します。引数には、挿入したいDom\Nodeオブジェクトを複数指定することも、文字列を複数指定することも可能です。文字列が引数として渡された場合、それは自動的にDom\Textノードに変換されて挿入されます。
この操作により、呼び出し元のノード自身は削除されずにそのまま残りますが、その前に新たな兄弟ノードが追加されるため、DOMツリーの構造が変更されます。例えば、特定の要素の前に別の要素やテキストを追加したい場合に有効です。現在のノードがDOMツリー内に親ノードを持たない場合（つまり、ツリーの一部ではない場合）、beforeメソッドを実行しても何も挿入されず、DOMツリーは変更されません。このメソッドは、既存のDOM構造を動的に操作し、コンテンツを追加する際に広く利用されます。
構文(syntax)
1<?php 2 3$document = new DOMDocument(); 4$document->loadHTML('<div><p id="target-node">既存の段落</p></div>'); 5$targetNode = $document->getElementById('target-node'); 6 7$newNode = $document->createElement('span', '挿入される新しいスパン'); 8 9$targetNode->before($newNode); 10 11?>
引数(parameters)
Dom\Node|string ...$nodes
- Dom\Node|string $nodes: 挿入するノードまたは文字列。複数指定可能です。
戻り値(return)
void
このメソッドは、指定されたノードの直前に新しいノードを挿入します。戻り値はありません。