【PHP8.x】Dom\HTMLElement::replaceChildren()メソッドの使い方

Copy
1<?php
2
3// Dom\HTMLDocument を作成します。
4// これはHTMLドキュメント全体のコンテナとなります。
5$document = new Dom\HTMLDocument();
6
7// ドキュメントの body 要素を作成し、ドキュメントに追加します。
8$body = $document->createElement('body');
9$document->appendChild($body);
10
11// body 要素にいくつかの子要素を追加して、初期状態を作成します。
12$spanElement = $document->createElement('span');
13$spanElement->textContent = 'これは最初の子要素です。';
14$body->appendChild($spanElement);
15
16$divElement = $document->createElement('div');
17$divElement->textContent = 'これは二番目の子要素です。';
18$body->appendChild($divElement);
19
20$textNode = $document->createTextNode('これはテキストノードです。');
21$body->appendChild($textNode);
22
23// 現在のHTML構造を出力して確認します。
24echo "--- 子要素追加後のHTML構造 ---" . PHP_EOL;
25echo $document->saveHTML() . PHP_EOL;
26
27// Dom\HTMLElement::replaceChildren() メソッドを使用して、
28// body 要素のすべての子要素を削除します。
29// 引数を渡さない場合、既存の子要素はすべて削除され、新しい子要素は追加されません。
30echo PHP_EOL . "--- replaceChildren() を使用して子要素をすべて削除します ---" . PHP_EOL;
31$body->replaceChildren(); // キーワード「removechild」に最も関連性の高い操作です。
32
33// 子要素が削除された後のHTML構造を出力して確認します。
34echo $document->saveHTML() . PHP_EOL;
35
36?>

PHP 8のDom\HTMLElement::replaceChildren()メソッドは、特定のHTML要素（Dom\HTMLElementオブジェクト）が持つすべての子要素を、指定した新しい子要素に置き換えるために使用されます。

このメソッドはDom\Nodeオブジェクトまたは文字列を可変長引数（...$nodes）として受け取ります。これにより、新しい子要素として追加したいDOMノードや単純なテキストを複数指定することが可能です。メソッドの実行により要素の構造が変更されますが、戻り値はvoidであり、特に値を返しません。

特に注目すべきは、このメソッドを引数なしで呼び出した場合の挙動です。サンプルコードのように$element->replaceChildren();と記述すると、その要素が現在持っているすべての子要素が削除され、新しい子要素は何も追加されません。この動作は、既存の子要素をまとめて削除したい場合（キーワード「removechild」の意図に近い操作）に非常に有効です。

サンプルコードでは、まずDom\HTMLDocumentにbody要素を作成し、span要素、div要素、そしてテキストノードという複数子要素を追加して初期状態を準備しています。その後、$body->replaceChildren();と引数なしで呼び出すことで、これらすべての追加された子要素が一度に削除され、body要素が空になる様子を確認できます。これにより、要素の子要素を効率的にクリアする方法として、このメソッドを活用できることが理解できるでしょう。

Copy
1<?php
2
3// DOM\HTMLElement::replaceChildren メソッドは、指定された要素のすべての子を新しい子に置き換えます。
4// これは、既存の子を削除し、新しい子を追加する操作を一度に行う便利な方法です。
5
6// 1. HTMLドキュメントを作成します。
7$document = new Dom\HTMLDocument();
8
9// 2. テスト用のHTML要素 (例えば<div>) を作成し、bodyに追加します。
10$containerDiv = $document->createElement('div');
11$containerDiv->id = 'myContainer';
12$document->body->append($containerDiv);
13
14// 3. replaceChildren を呼び出す前に、いくつかの子要素を追加します。
15$originalChild1 = $document->createElement('p');
16$originalChild1->textContent = 'これは元の子要素 1 です。';
17$containerDiv->append($originalChild1);
18
19$originalChild2 = $document->createElement('span');
20$originalChild2->textContent = 'これは元の子要素 2 です。';
21$containerDiv->append($originalChild2);
22
23echo "--- replaceChildren 呼び出し前 ---\n";
24// outerHTML は要素とその内容を含むHTML文字列を返します。
25echo $containerDiv->outerHTML . "\n\n";
26
27// 4. 新しい子要素を作成します。文字列を直接渡すこともできます。
28$newChildA = $document->createElement('h3');
29$newChildA->textContent = 'これは新しく追加された見出しです。';
30
31$newChildB = $document->createElement('li');
32$newChildB->textContent = 'これは新しいリスト項目です。';
33
34// 文字列として渡されるテキストノード
35$stringChild = 'これは直接文字列として追加されたテキストです。';
36
37// 5. replaceChildren メソッドを呼び出し、既存の子要素を新しい子要素に置き換えます。
38// 引数として複数の Dom\Node オブジェクトや文字列を渡すことができます。
39$containerDiv->replaceChildren($newChildA, $newChildB, $stringChild);
40
41echo "--- replaceChildren 呼び出し後 ---\n";
42echo $containerDiv->outerHTML . "\n";
43
44?>

PHPのDom\HTMLElement::replaceChildrenメソッドは、特定のHTML要素に存在するすべての子要素を、指定された新しい子要素に一度に置き換えるための機能です。このメソッドを使用すると、既存の子要素を削除し、その後に新しい子要素を追加するという一連の操作を、より簡潔かつ効率的に実行できます。

サンプルコードでは、まずDom\HTMLDocumentを作成し、その中にテスト用の<div>要素を用意しています。この<div>には、初期状態でpタグとspanタグという2つの子要素が追加されています。replaceChildrenメソッドを呼び出す前と後で、<div>のHTML内容がどのように変化するかが確認できます。

replaceChildrenメソッドを呼び出す際には、新しく作成したh3タグやliタグといったDom\Nodeオブジェクト、そして直接記述された文字列を引数に渡しています。この操作を実行すると、元々<div>内に存在していたpタグとspanタグの子要素はすべて削除され、代わりにh3、li、および文字列が新たな子要素として設定されます。

引数にはDom\Nodeオブジェクトや文字列を複数指定することができ、それらが順番に新しい子要素として追加されます。メソッドの戻り値はvoidであり、特に何も値を返しません。ウェブページ上で要素の内容を動的に更新する際に、既存の内容を一掃して新しい内容をまとめて設定したい場合に非常に役立つメソッドです。