いっしー@Webエンジニア
Webツールプログラミング言語プログラミング学習ITニュースIT用語辞典ポートフォリオ
Webエンジニア向けプログラミング解説動画をYouTubeで配信中！
▶ チャンネル登録はこちら

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

replaceChildrenメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

replaceChildrenメソッドは、XMLやHTMLドキュメントの構造を操作する際に、特定の親ノードのすべての子ノードを、新しく指定されたノードで置き換えることを実行するメソッドです。このメソッドは、PHPのDOM拡張機能の一部であるDOMDocumentクラスに属しており、ドキュメントツリー内の特定の部分のコンテンツを一括して更新するために利用されます。

具体的には、replaceChildrenメソッドを呼び出すと、対象となるノードが現在持っている既存の子ノードがすべて削除されます。その後、このメソッドの引数として渡された新しいノードや文字列が、指定された順序で対象ノードの子として追加されます。引数には、DOMNodeオブジェクト（例えばDOMElementやDOMTextなど）を複数渡すことができ、文字列を渡した場合は自動的にDOMTextノードとして扱われ、テキストコンテンツとして追加されます。

この機能は、既存のコンテンツを完全に新しい内容で置き換えたい場合や、サーバーサイドで動的に生成された複数の要素を一度に親ノードに追加したい場合に非常に便利です。複雑なDOM操作を簡潔なコードで実現し、ドキュメントの整合性を保ちながら効率的な更新を行うことが可能になります。

構文(syntax)

1<?php
2
3$dom = new DOMDocument();
4$newRootElement = $dom->createElement('root');
5$dom->replaceChildren($newRootElement);
6
7?>

引数(parameters)

\DOMNode ...$nodes

  • \DOMNode ...$nodes: 置換する新しい子ノードを指定する、可変長引数 (\DOMNode オブジェクトのリスト)

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

DOMDocumentで子ノードを削除する

1<?php
2
3/**
4 * DOMDocument を使用してXML構造を作成し、子ノードを削除する例を示します。
5 * replaceChildren() メソッドを引数なしで呼び出すことで、
6 * 指定されたノードの全ての子ノードを削除できます。
7 */
8
9// 1. DOMDocument のインスタンスを作成
10// XMLバージョンとエンコーディングを指定
11$dom = new DOMDocument('1.0', 'UTF-8');
12$dom->formatOutput = true; // 出力を見やすく整形する設定
13
14// 2. ルート要素を作成し、DOM に追加
15$rootElement = $dom->createElement('data');
16$dom->appendChild($rootElement);
17
18// 3. いくつかの子要素を作成し、ルート要素に追加
19$item1 = $dom->createElement('item', '最初の項目');
20$rootElement->appendChild($item1);
21
22$item2 = $dom->createElement('item', '2番目の項目');
23$rootElement->appendChild($item2);
24
25$item3 = $dom->createElement('item', '最後の項目');
26$rootElement->appendChild($item3);
27
28echo "--- replaceChildren() 実行前のDOM構造 ---" . PHP_EOL;
29// 現在のDOM構造をXML形式で出力
30echo $dom->saveXML() . PHP_EOL;
31
32// 4. replaceChildren() メソッドを呼び出して全ての子ノードを削除
33// $rootElement の全ての子ノードを、引数なしで空のリストに置き換える（削除する）
34// これが「php removechild」キーワードに最も関連性の高い使い方です。
35$rootElement->replaceChildren();
36
37echo "--- replaceChildren() 実行後のDOM構造 (全ての子ノードが削除されました) ---" . PHP_EOL;
38// 子ノード削除後のDOM構造をXML形式で出力
39echo $dom->saveXML() . PHP_EOL;
40
41?>

replaceChildren()メソッドは、PHPのDOM（Document Object Model）操作において、指定したノードの子ノードを置き換えるために使用されます。このメソッドはDOMNodeクラスに属し、XMLやHTMLドキュメントの構造をプログラムで操作する際に役立ちます。

引数として\DOMNode ...$nodesを受け取ります。これは、置き換えたい新しい子ノードを可変個数で指定できることを意味します。もしこの引数を何も渡さずにreplaceChildren()メソッドを呼び出した場合、対象ノードの現在の子ノードはすべて削除され、新しい子ノードは追加されません。この挙動が、実質的に「php removechild」というキーワードが示す子ノードの削除操作に該当します。メソッドの呼び出し元に返される値はありません（戻り値なし）。

サンプルコードでは、まずDOMDocumentインスタンスを作成し、dataというルート要素とその下にitemという子要素を3つ作成しています。echo $dom->saveXML()で実行前のDOM構造を確認できます。 次に、$rootElementに対して$rootElement->replaceChildren();と引数なしでメソッドを呼び出しています。これにより、$rootElementであるdata要素の全ての子ノード（item要素3つ）が削除されます。再度echo $dom->saveXML()で実行後のDOM構造を見ると、data要素の子ノードが全てなくなっていることがわかります。このように、replaceChildren()メソッドを引数なしで利用することで、特定ノードの全ての子ノードを簡単に削除できます。

replaceChildren()メソッドを引数なしで呼び出すと、対象ノードの全ての子ノードが削除されます。これは「php removechild」キーワードが示すような、子ノードの一括削除に最も適した使い方です。引数に\DOMNodeオブジェクトを渡した場合、既存の子ノードは、渡されたノード群にすべて置き換わります。そのため、特定のノードだけを削除する目的で使うと意図しない結果になる可能性があるためご注意ください。このメソッドは戻り値がありませんので、操作の成否を直接確認する手段はありません。XMLやHTMLのようなツリー構造のデータを操作するDOMDocumentクラスの機能として、操作対象の要素をよく確認し、適切に利用することが重要です。

PHP DOMDocument::replaceChildren で要素の子ノードを置き換える

1<?php
2
3// DOMDocument オブジェクトを作成します。
4// '1.0' は XML のバージョン、'UTF-8' はエンコーディングです。
5$dom = new DOMDocument('1.0', 'UTF-8');
6
7// 出力されるHTMLを見やすくするために整形を有効にします。
8$dom->formatOutput = true;
9
10// 処理対象となるHTML文字列をロードします。
11$html = <<<HTML
12<html>
13<head>
14    <title>元のタイトル</title>
15</head>
16<body>
17    <div id="content_area">
18        <p>これは元の段落1です。</p>
19        <span>元のテキスト要素</span>
20        <p>これは元の段落2です。</p>
21    </div>
22    <div id="other_area">
23        <p>別の領域のコンテンツ。</p>
24    </div>
25</body>
26</html>
27HTML;
28$dom->loadHTML($html);
29
30// idが "content_area" の要素を取得します。
31// この要素の子ノードを置き換えます。
32$targetElement = $dom->getElementById('content_area');
33
34// 対象要素が見つかった場合のみ処理を実行します。
35if ($targetElement) {
36    echo "--- 置き換え前のHTMLの状態 ---\n";
37    echo $dom->saveHTML() . "\n\n";
38
39    // 新しい子ノードとして追加する要素を作成します。
40    // replaceChildren は可変長引数を受け取るため、複数のノードを渡すことができます。
41    $newHeading = $dom->createElement('h2', '新しい見出しです');
42    $newParagraph = $dom->createElement('p', 'ここが置き換え後の新しいコンテンツです。');
43    $newSpan = $dom->createElement('span', 'さらに別の新しい要素も追加されました。');
44
45    // DOMDocument::replaceChildren メソッドを使用して、
46    // $targetElement の全ての子ノードを、作成した新しいノードで置き換えます。
47    $targetElement->replaceChildren($newHeading, $newParagraph, $newSpan);
48
49    echo "--- replaceChildren 実行後のHTMLの状態 ---\n";
50    echo $dom->saveHTML();
51} else {
52    echo "ID 'content_area' を持つ要素が見つかりませんでした。\n";
53}

PHPのDOMDocument::replaceChildrenメソッドは、HTMLやXML文書内の特定の要素が持つ全ての子ノードを、指定された新しいノード群で一括して置き換えるための機能です。Webページの一部分のコンテンツを動的に更新したい場合などに非常に便利です。

このメソッドは\DOMNode ...$nodesという引数を取ります。これは、新しいDOMNode型のオブジェクト（例えば、新しく作成したHTML要素など）を複数、可変長で受け取れることを意味します。これらのノードは、対象要素の既存の子ノードを全て削除した後に、その位置に追加されます。戻り値は特にありません。このメソッドの実行が、直接DOMツリー（文書構造）を書き換える挙動となります。

サンプルコードでは、まずDOMDocumentオブジェクトでHTML文字列をロードし、getElementByIdメソッドを使ってIDがcontent_areaの要素を取得しています。この要素の子ノードを置き換える対象となります。その後、createElementメソッドで新しい見出し（h2）、段落（p）、テキスト要素（span）といったDOMノードを作成します。最終的に、取得した$targetElementに対してreplaceChildrenメソッドを呼び出し、作成した新しい複数のノードを引数として渡すことで、content_area内にあった元の子ノード群（元の段落やテキスト要素）が、新しい見出しや段落、テキスト要素に完全に置き換えられていることを、前後のHTML出力で確認できます。この機能は、Webアプリケーションでコンテンツの一部を効率的に更新する際に役立ちます。

DOMDocument::replaceChildrenは、指定した要素の全ての子ノードを、引数で渡された新しいノード群で完全に置き換えるメソッドです。既存の子ノードは全て削除されますので、必要な情報はあらかじめ取得しておく必要があります。引数には文字列ではなく、createElementなどで作成したDOMNodeオブジェクトを渡してください。対象となる要素がgetElementByIdなどで取得できずnullではないことを確認してから呼び出すことが重要です。複数のノードを一度に渡せるため、まとめて子要素を更新したい場合に便利です。置き換え後のHTMLが意図した構造になっているか、saveHTML()などで必ず確認するようにしてください。

関連コンテンツ

関連IT用語

関連プログラミング言語