【PHP8.x】beforeメソッドの使い方

beforeメソッドは、Dom\Elementクラスのインスタンスが表す要素の直前に、一つまたは複数の新しいコンテンツを挿入するメソッドです。これはXMLやHTMLなどのDOMツリーをプログラムから操作する際に用いられます。

具体的には、このメソッドが呼び出されたDom\Elementオブジェクト（対象要素）の親ノードの子リストにおいて、対象要素のすぐ前に、引数として渡されたノードやテキストが追加されます。引数には、Dom\Nodeのサブクラスのインスタンス（例えば、別のDom\ElementやDom\Textなど）や、単なる文字列を可変長引数として複数指定できます。文字列が渡された場合、それは自動的にDom\Textノードとして扱われ、挿入されます。

もし引数として渡されたDom\Nodeが既にDOMツリー内に存在する場合、そのノードは元の位置から移動され、対象要素の直前に挿入されます。このメソッドは、新しい要素やテキストを既存の要素の前に動的に追加する際に非常に有用です。なお、対象要素に親ノードが存在しない場合、この操作は行われません。

Copy
1<?php
2// $targetElement は Dom\Element クラスのインスタンスと仮定します。
3// $newNode は Dom\Node クラス（例: Dom\Element, Dom\Text など）のインスタンスと仮定します。
4
5$targetElement->before('挿入したい文字列や', $newNode, '別の挿入したい文字列やDom\Node');

Dom\Node|string ...$nodes

• Dom\Node|string $nodes: 追加するDOMノードまたはHTML文字列。可変長引数として複数指定可能。

void

このメソッドは、指定されたDOM要素の前に新しいノードを挿入するために使用されます。操作が完了した後に、このメソッドは値を返しません。戻り値はありません。