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

beforeメソッドは、指定されたノードまたはノードリストを、現在のテキストノードの直前に挿入するメソッドです。

Dom\Textクラスは、HTMLやXML文書の構造をプログラムで操作するためのDOM (Document Object Model) 機能において、文書内の純粋なテキストデータそのものを表すノードです。このbeforeメソッドは、そのDom\Textインスタンスが表すテキストノードの、兄弟ノードとして直前に新しいノードを挿入する役割を持ちます。

具体的には、このメソッドは引数として渡されたノード（Dom\Nodeオブジェクト）やノードの配列、またはHTML文字列を、呼び出し元のテキストノードの親ノードの子として、テキストノードの前に配置します。例えば、<p>既存のテキスト</p>というHTML構造で「既存のテキスト」の部分がDom\Textオブジェクトである場合、このオブジェクトに対してbefore('<span>新しい要素</span>')を実行すると、結果として<p><span>新しい要素</span>既存のテキスト</p>のような構造になります。元のテキストノード自体が変更されることはなく、その位置の前に新しいコンテンツが追加されるため、既存の構造を維持しつつ柔軟に要素を挿入できます。

引数には、挿入したい単一のDom\Nodeオブジェクト、複数のDom\Nodeオブジェクトを含む配列、あるいはHTML文字列を指定できます。HTML文字列が指定された場合は、内部的にDom\DocumentFragmentとして解析され、その内容が挿入されます。成功した場合、このメソッドは挿入されたノードのうち、最初のものをDom\Nodeオブジェクトとして返します。この機能は、Webページの動的な更新や、XMLデータのプログラムによる構造変更を行う際に、既存のコンテンツの前に情報を追加したい場合に非常に有効です。

Copy
1<?php
2
3$dom = new DOMDocument();
4$element = $dom->createElement('p');
5$targetText = $dom->createTextNode('既存のテキスト');
6$element->appendChild($targetText);
7$dom->appendChild($element);
8
9$newNode = $dom->createTextNode('新しいテキスト');
10
11$targetText->before($newNode);
12
13?>

Dom\Node|string ...$nodes

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

void

このメソッドは、指定されたテキストノードの前に新しいノードを挿入します。操作が完了しても、このメソッド自体は何も返しません。