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

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成し、HTMLコンテンツを管理する
4$dom = new DOMDocument('1.0', 'UTF-8');
5// 出力時に整形されるように設定し、読みやすくする
6$dom->formatOutput = true;
7
8// ドキュメントのルート要素として<body>を作成し、追加する
9$body = $dom->appendChild($dom->createElement('body'));
10
11// 親となる<div>要素を作成し、<body>に追加する
12$parentElement = $body->appendChild($dom->createElement('div'));
13$parentElement->setAttribute('id', 'container');
14
15// 親要素にいくつかの子要素（<p>と<span>）を追加する
16$parentElement->appendChild($dom->createElement('p', '最初の子要素です。'));
17$parentElement->appendChild($dom->createElement('span', '二番目の子要素です。'));
18$parentElement->appendChild($dom->createElement('p', '三番目の子要素です。'));
19
20echo "--- replaceChildren() 実行前のHTML ---" . PHP_EOL;
21echo $dom->saveHTML() . PHP_EOL . PHP_EOL;
22
23// DOMParentNode::replaceChildren() を使用して、親要素の全ての子要素を削除する
24// 引数を渡さない場合、既存の子要素は全て削除され、新しい子要素は追加されない
25$parentElement->replaceChildren();
26
27echo "--- replaceChildren() 実行後のHTML (全ての子要素を削除) ---" . PHP_EOL;
28echo $dom->saveHTML() . PHP_EOL;
29
30?>

PHPのDOMParentNode::replaceChildren()メソッドは、HTML要素の子要素を効率的に操作するための機能です。このメソッドは、指定した親要素の現在の子要素をすべて削除し、新しい子要素に置き換えることができます。

引数には、新しく追加する子要素としてDOMNodeオブジェクトまたは文字列を複数指定できます。例えば、DOMElementオブジェクトを渡せば新しいHTML要素を追加でき、文字列を渡せばテキストノードを追加できます。

特に、引数を一つも渡さずに$parentElement->replaceChildren();のように呼び出す場合、既存のすべての子要素は削除されますが、新しい子要素は追加されません。これにより、特定の親要素からすべての子要素を簡単に削除する機能として利用できます。メソッドの戻り値はvoidであり、何も返しません。

サンプルコードでは、まずid="container"を持つ<div>要素を作成し、その中にいくつかの<p>要素と<span>要素を追加しています。その後、$parentElement->replaceChildren();を引数なしで呼び出すことで、この<div>要素内の既存の子要素がすべて削除され、空の状態になる様子を確認できます。実行前後のHTML出力を比較することで、このメソッドの働きを明確に理解することができます。

Copy
1<?php
2
3/**
4 * DOMParentNode::replaceChildren メソッドのサンプルコード
5 *
6 * このメソッドは、指定された DOM 要素のすべての子要素を、
7 * 提供された新しいノードまたは文字列で置き換えます。
8 * PHP 8 以降で利用可能です。
9 */
10
11// 1. 新しい DOM ドキュメントを作成します。
12$dom = new DOMDocument('1.0', 'UTF-8');
13$dom->formatOutput = true; // 出力を見やすくするために整形を有効にします。
14
15// 2. ルートとなる 'container' 要素を作成し、ドキュメントに追加します。
16$container = $dom->createElement('div');
17$container->setAttribute('id', 'container');
18$dom->appendChild($container);
19
20// 3. 'container' 要素にいくつかの子要素（段落）を追加します。
21$p1 = $dom->createElement('p', 'これは最初の段落です。');
22$container->appendChild($p1);
23
24$p2 = $dom->createElement('p', 'これは2番目の段落です。');
25$container->appendChild($p2);
26
27$span = $dom->createElement('span', 'これはスパン要素です。');
28$container->appendChild($span);
29
30echo "--- 置き換え前のDOM構造 ---" . PHP_EOL;
31echo $dom->saveHTML() . PHP_EOL; // 現在のDOM構造を出力します。
32
33// 4. DOMParentNode::replaceChildren を使用して、
34//    'container' のすべての子要素を新しいコンテンツで置き換えます。
35//    引数には DOMNode オブジェクトと文字列の両方を渡すことができます。
36$newParagraph = $dom->createElement('p', '新しく追加された段落です！');
37$newDiv = $dom->createElement('div');
38$newDiv->appendChild($dom->createTextNode('そしてこれは新しいdiv内のテキストです。'));
39
40$container->replaceChildren(
41    $newParagraph,            // DOMNode オブジェクト
42    $newDiv,                  // 別の DOMNode オブジェクト
43    'これは単なるテキストノードです。', // 文字列
44    $dom->createElement('br'),// 空の要素も追加可能
45    '最終的な新しいコンテンツです。' // 最後の文字列
46);
47
48echo "--- 置き換え後のDOM構造 ---" . PHP_EOL;
49echo $dom->saveHTML() . PHP_EOL; // 置き換え後のDOM構造を出力します。
50
51?>

DOMParentNode::replaceChildrenメソッドは、PHP 8以降で利用可能なDOM操作のための機能です。このメソッドは、指定されたHTMLやXMLの要素（親ノード）が持つすべての子要素を、一度に新しい内容で置き換える役割を果たします。従来のPHPでは、要素の子要素をすべて入れ替えるには、既存の子要素を一つずつ削除してから新しい子要素を追加する手間がありましたが、replaceChildrenはこのプロセスを非常に簡潔に記述できるようにします。

サンプルコードでは、まずcontainerというdiv要素に複数の段落（p要素）やspan要素を追加し、その初期状態を出力しています。その後、$container->replaceChildren(...)を呼び出すことで、container要素の元々の子要素をすべて削除し、新しいp要素、div要素、直接指定したテキスト文字列、そしてbr要素などで完全に置き換えています。

引数には、DOMNodeオブジェクト（例えば、新しく作成したp要素やdiv要素）や、単なる文字列（それがそのままテキストノードとして追加されます）を、複数個必要なだけ渡すことができます。これらの引数は順番に新しい子要素として追加されます。このメソッドの戻り値はvoidであり、処理が完了しても特に値を返しません。replaceChildrenは、Webコンテンツの動的な更新やXMLデータの加工において、既存の子要素の一括置換を効率的に行うための「php replace関数」として非常に役立ちます。