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

replaceChildrenメソッドは、DOMElementオブジェクトのすべての子ノードを削除し、指定された新しいノードまたはノード群に置き換える処理を実行するメソッドです。このメソッドを呼び出すと、まず対象となるDOMElementインスタンスが現在持っているすべての子ノードが完全にクリアされます。その後、引数として渡された新しいノード（DOMNodeオブジェクト）やノードの配列が、そのDOMElementの子ノードとして指定された順序で追加されます。

もし引数に何もノードが渡されなかった場合、そのDOMElementからはすべての子ノードが削除されるだけで、新しい子ノードは追加されません。この機能により、Webページなどの動的なUI更新において、要素のコンテンツを効率的かつ一度の操作で完全に更新することが可能になります。既存の子ノードを一つずつ削除し、その後新しいノードを一つずつ追加するといった複数のステップを、このメソッド一つで完結できるため、コードの可読性を高め、処理の簡素化にも貢献します。PHP 8.0で導入されたこのメソッドは、DOM操作における一般的なパターンをより直感的かつ効率的に記述するための重要な機能の一つです。

Copy
1<?php
2$dom = new DOMDocument();
3$parentElement = $dom->createElement('container');
4$dom->appendChild($parentElement);
5
6// 既存の子要素を親要素に追加
7$parentElement->appendChild($dom->createElement('old_item', 'Item A'));
8$parentElement->appendChild($dom->createElement('old_item', 'Item B'));
9
10// 新しい子要素を作成
11$newItem1 = $dom->createElement('new_item', 'Item X');
12$newItem2 = $dom->createElement('new_item', 'Item Y');
13
14// 既存の全ての子要素を、指定された新しい子要素で置き換える
15$parentElement->replaceChildren($newItem1, $newItem2);

?DOMNode ...$nodes

• ?DOMNode ...$nodes: 既存の子ノードを置き換えるための、0個以上のDOMNodeオブジェクトまたはnull。可変長引数として指定します。

DOMNode|false

このメソッドは、要素の子ノードをすべて新しいノードリストで置き換えた場合、成功したDOMNodeオブジェクトを返します。置き換えに失敗した場合はfalseを返します。