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

replaceChildrenメソッドは、呼び出し元であるDom\HTMLDocumentオブジェクトの全ての子ノードを、指定された新しいノードの集合に置き換えるメソッドです。このメソッドを使用すると、HTML文書全体を表現するDom\HTMLDocumentオブジェクトが現在持っている子要素（テキストや他のHTMLタグなど）を一度にすべて削除し、新しく渡された内容で完全に上書きすることができます。

具体的には、引数として一つ以上のDOMNodeオブジェクトや文字列を渡すことができます。DOMNodeオブジェクトを渡した場合は、それがそのまま新しい子ノードとして追加されます。文字列を渡した場合は、その文字列はテキストノードとして解釈され、HTML文書に追加されます。引数を何も渡さない場合は、既存の子ノードがすべて削除され、Dom\HTMLDocumentオブジェクトは子ノードを持たない状態になります。

この機能は、HTML文書のコンテンツを動的に完全に更新したい場合に非常に便利です。例えば、ユーザーの操作に応じてページのメインコンテンツ全体を入れ替えたり、初期表示後にサーバーから取得したデータで文書の内容をまるごと構築し直したりするシナリオで活用できます。既存の子ノードを手動で一つずつ削除してから新しいノードを追加する手間を省き、効率的にDOMを操作することが可能です。このメソッドはPHP 8で導入され、より現代的で直感的なDOM操作を提供します。

Copy
1<?php
2
3$document = new DOM\HTMLDocument();
4
5// 新しい HTML 要素を作成し、その中に body と p 要素を追加
6$htmlElement = $document->createElement('html');
7$bodyElement = $document->createElement('body');
8$bodyElement->appendChild($document->createElement('p', '新しいコンテンツです。'));
9$htmlElement->appendChild($bodyElement);
10
11// Dom\HTMLDocument の replaceChildren メソッドを呼び出し、
12// ドキュメントの既存の子ノード（もしあれば）を新しい HTML 要素で置き換える
13$document->replaceChildren($htmlElement);
14
15echo $document->saveHTML();
16
17?>

Dom\Node|string ...$nodes

• Dom\Node|string $nodes: 置換する子ノード、またはHTML文字列を指定します。可変長引数です。

void

このメソッドは、要素のすべての子ノードを置き換えます。戻り値はありません。