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

insertBeforeメソッドは、HTMLやXMLのような文書の階層構造（DOMツリー）において、指定した新しいノードを、既存の子ノードの前に挿入するメソッドです。このメソッドはDOMDocumentクラスに属しており、PHPで文書の構造を動的に操作する際に非常に有用です。

具体的には、第一引数に挿入したい新しい子ノード（DOMNodeオブジェクトなど）を渡します。そして、第二引数には、新しい子ノードを挿入する位置の「基準」となる既存の子ノード（DOMNodeオブジェクト）を指定します。新しいノードはこの基準ノードの直前に配置されます。

もし第二引数にnullを指定した場合、挿入される新しいノードは、親ノード（このメソッドを呼び出すDOMDocumentオブジェクト自身、またはその子ノード）の最後の子ノードとして追加されます。これにより、文書内に要素を動的に追加したり、既存の要素の順序を変更したりといった柔軟な操作が可能になります。メソッドは成功した場合、挿入された新しいノード自身を返します。

Copy
1<?php
2$dom = new DOMDocument();
3$root = $dom->createElement('root');
4$dom->appendChild($root);
5
6$existingChild = $dom->createElement('existing_child');
7$root->appendChild($existingChild);
8
9$newElement = $dom->createElement('new_child');
10
11// newElement を existingChild の前に挿入し、挿入されたノードを受け取る
12$insertedNode = $root->insertBefore($newElement, $existingChild);
13?>

DOMNode $node, ?DOMNode $child = null

• DOMNode $node: 挿入するノード
• ?DOMNode $child = null: $node を挿入する前に配置される子ノード。省略された場合は、既存の子ノードの末尾に挿入される

DOMNode

DOMDocument::insertBeforeメソッドは、新しく挿入されたノードを返します。