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

beforeメソッドは、呼び出し元のDom\CDATASectionオブジェクトが表すノードの直前に、一つまたは複数のノードを挿入するメソッドです。このメソッドは、指定されたノードを現在のノードの兄弟として、かつその前に配置することで、DOMツリーの構造を変更します。

引数には、挿入したいDom\Nodeオブジェクトを一つ、または複数のDom\Nodeオブジェクトを要素とする配列を指定できます。例えば、新しいテキストノードや要素ノードを、既存のCDATAセクションの直前に簡単に追加することが可能です。もし挿入するノードがすでに別のDOMツリーに属している場合、そのノードは元の位置から削除され、新しい位置に移動します。

このメソッドは、PHP 8で導入された新しいDOM操作APIの一部であり、より直感的で簡潔なコードでDOMツリーを編集できるよう設計されています。insertBeforeメソッドと異なり、参照ノードを指定する必要がなく、現在のノードの直前という明確な位置に挿入できます。

メソッドが正常に実行されると、挿入されたノード、または挿入されたノードの配列が返されます。ただし、呼び出し元のノードがDOMツリーに属していない場合や、親ノードが存在しない場合など、特定の条件下ではDom\Exceptionがスローされる可能性がありますので、利用する際には注意が必要です。DOMツリーの柔軟な編集を可能にし、動的なウェブコンテンツ生成などに役立ちます。

Copy
1<?php
2
3$document = new DOMDocument();
4$cdataSection = $document->createCDATASection("original data");
5
6$nodeToPrepend1 = $document->createTextNode("First new text");
7$nodeToPrepend2 = $document->createElement("item", "Second new element");
8
9$cdataSection->before($nodeToPrepend1, $nodeToPrepend2, "Third new string");

Dom\Node|string ...$nodes

• Dom\Node|string ...$nodes: 追加するノードまたは文字列の可変長引数

void

このメソッドは、指定されたノードをこのノードの直前に挿入します。戻り値はありません。