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

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

作成日: 2025年09月11日更新日: 2025年11月06日

基本的な使い方

replaceChildメソッドは、DOMDocumentクラスに属するメソッドで、ノードを別のノードで置き換える操作を実行します。具体的には、指定された親ノードの子ノードリストにおいて、既存の子ノードを新しいノードで置き換えます。

このメソッドは、システムエンジニアを目指す初心者にとって、XMLやHTMLドキュメントをプログラムで操作する上で非常に重要な役割を果たします。例えば、ウェブサイトの特定の要素を動的に変更したり、XML形式の設定ファイルを更新したりする際に利用できます。

replaceChildメソッドは、置き換えられる古いノードと、新しく挿入するノードの2つの引数を必要とします。メソッドが呼び出される親ノードは、置き換え操作の対象となるノードの親ノードである必要があります。もし新しいノードが既にドキュメントに存在する場合、それは元の場所から削除され、新しい場所に挿入されます。

メソッドの実行後、置き換えられた古いノードはドキュメントから削除され、新しいノードがその場所に挿入されます。メソッドは、置き換えられた古いノードを返します。もしエラーが発生した場合（例えば、親ノードが存在しない場合など）、例外がスローされる可能性があります。

このメソッドを理解し、適切に使用することで、PHPを使用してXMLやHTMLドキュメントを効率的に操作できるようになり、より高度なWebアプリケーションやシステム開発に貢献できます。DOMDocumentクラスの他のメソッドと組み合わせて使用することで、ドキュメントの構造を自在に操作することが可能になります。

構文(syntax)


1DOMDocument::replaceChild(DOMNode $newChild, DOMNode $oldChild): DOMNode|false

引数(parameters)

DOMNode $newChild, DOMNode $oldChild

DOMNode $newChild: 挿入する新しい子ノードを指定します。
DOMNode $oldChild: 置き換える既存の子ノードを指定します。

戻り値(return)

DOMNode

指定されたノードを、指定された親ノードの指定された位置に挿入し、既存のノードを置き換えた後、削除された元のノードを返します。

サンプルコード

DOMDocument::replaceChildでノードを置換する


1<?php
2
3// 新しいノードで古いノードを置換する例
4$dom = new DOMDocument();
5$dom->loadXML('<root><old_node>Old Content</old_node></root>');
6
7$oldNode = $dom->getElementsByTagName('old_node')->item(0);
8
9// 新しいノードを作成
10$newNode = $dom->createElement('new_node', 'New Content');
11
12// 古いノードを新しいノードで置換
13$replacedNode = $dom->documentElement->replaceChild($newNode, $oldNode);
14
15// 置換後のXMLを出力
16echo $dom->saveXML();
17
18?>

このPHPのサンプルコードは、DOMDocumentクラスのreplaceChildメソッドを使用して、XMLドキュメント内のノードを置換する方法を示しています。

まず、DOMDocumentクラスのインスタンスを作成し、loadXMLメソッドでXML文字列を読み込みます。この例では、<root>要素内に<old_node>要素が含まれるシンプルなXML構造をロードしています。

次に、getElementsByTagNameメソッドを使って<old_node>要素を取得し、item(0)で最初の要素（ここでは唯一の要素）を $oldNode 変数に格納します。これが置換対象となる古いノードです。

createElementメソッドを使って、新しいノード $newNode を作成します。このノードは、置換後の内容を持つ<new_node>要素です。

そして、replaceChildメソッドが重要な役割を果たします。このメソッドは、DOMNodeオブジェクト（ここでは $dom->documentElement、つまり<root>要素）から呼び出され、第一引数に新しいノード $newNode、第二引数に置換対象の古いノード $oldNode を受け取ります。replaceChildメソッドは、古いノードを新しいノードで置換し、置換された古いノード（この例では $oldNode）を返します。サンプルコードでは、この戻り値を $replacedNode に格納しています。

最後に、saveXMLメソッドを使って、置換後のXMLドキュメントを出力しています。出力結果は<root>要素内の<old_node>要素が<new_node>要素に置き換わったXML文字列になります。このコードを実行することで、XMLドキュメント内の特定のノードを、プログラムによって動的に置換できることを理解できます。

DOMDocument::replaceChildメソッドは、XMLドキュメント内のノードを別のノードで置き換える際に使用します。$oldChildは必ずDOMDocumentに属するノードである必要があります。異なるドキュメントからインポートされていないノードを渡すとエラーが発生します。$newChildは置換後のノードであり、createElementなどで事前に作成しておく必要があります。置換が成功すると、置換された古いノードが返されます。$oldChildが存在しない場合は例外がスローされます。replaceChildを実行する際は、対象のノードが実際に存在するか、事前に確認することを推奨します。

PHP DOMDocument replaceChildでノードを置き換える


1<?php
2
3/**
4 * DOMDocument::replaceChild メソッドの使用例を示します。
5 *
6 * この関数は、指定されたHTML文字列をDOMDocumentにロードし、
7 * 特定の既存の子ノードを新しい子ノードに置き換える方法をデモンストレーションします。
8 *
9 * DOMDocument::replaceChild は、DOMNode $newChild と DOMNode $oldChild を引数にとり、
10 * 親ノードの $oldChild を $newChild で置き換えます。
11 * 成功した場合、置き換えられた (元の) $oldChild ノードを返します。
12 */
13function demonstrateDomReplaceChild(): void
14{
15    // 1. DOMDocument オブジェクトを作成します。
16    // '1.0' はXMLバージョン、'UTF-8' はエンコーディングです。
17    $dom = new DOMDocument('1.0', 'UTF-8');
18
19    // 生成されるHTMLを見やすくするために、出力フォーマットを有効にします。
20    $dom->formatOutput = true;
21
22    // 置き換え操作を行うためのHTMLコンテンツを定義します。
23    $htmlContent = <<<HTML
24<!DOCTYPE html>
25<html>
26<head>
27    <title>DOM ReplaceChild Example</title>
28</head>
29<body>
30    <h1>DOM操作のデモンストレーション</h1>
31    <p>この段落は変更されません。</p>
32    <div id="target-container">
33        <h2>この見出しが新しい段落に置き換えられます。</h2>
34        <p>この段落も変更されません。</p>
35    </div>
36</body>
37</html>
38HTML;
39
40    // 2. HTMLコンテンツをDOMDocumentにロードします。
41    // 第2引数としてLIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD を追加すると
42    // DOMDocumentが自動的に付加する<html>や<body>タグを防ぎ、より厳密なHTMLパースが可能です。
43    // 今回は初心者向けのためデフォルトの挙動を使用します。
44    $dom->loadHTML($htmlContent);
45
46    echo "--- 元のDOM構造 ---" . PHP_EOL;
47    echo $dom->saveHTML() . PHP_EOL;
48
49    // 3. 置き換えたい既存の子ノード（$oldChild）を見つけます。
50    // ここでは、id="target-container" のdiv要素内のh2要素を探します。
51    $targetContainer = $dom->getElementById('target-container');
52    $oldChild = null;
53
54    if ($targetContainer) {
55        foreach ($targetContainer->childNodes as $child) {
56            // DOMTextノードや他のノードタイプをスキップし、要素ノードのみを対象とします。
57            if ($child->nodeType === XML_ELEMENT_NODE && $child->nodeName === 'h2') {
58                $oldChild = $child;
59                break;
60            }
61        }
62    }
63
64    if ($oldChild) {
65        // 4. 新しい子ノード（$newChild）を作成します。
66        $newChild = $dom->createElement('p', 'この見出しは新しい段落に置き換えられました！');
67        $newChild->setAttribute('class', 'replaced-content');
68
69        // 5. replaceChild メソッドを呼び出してノードを置き換えます。
70        // replaceChild は、置き換えられる元のノードを返します。
71        // 親ノードが存在することを確認してから操作を行います。
72        if ($oldChild->parentNode) {
73            $replacedNode = $oldChild->parentNode->replaceChild($newChild, $oldChild);
74
75            echo "--- ノード置換後のDOM構造 ---" . PHP_EOL;
76            echo $dom->saveHTML() . PHP_EOL;
77
78            echo "操作結果:" . PHP_EOL;
79            echo "  成功: '{$replacedNode->textContent}' ({$replacedNode->nodeName}) が新しいノードに置き換えられました。" . PHP_EOL;
80            echo "  新しいノードの内容: '{$newChild->textContent}'" . PHP_EOL;
81        } else {
82            echo "エラー: 置き換え対象のノードに親ノードがありません。" . PHP_EOL;
83        }
84    } else {
85        echo "エラー: 置き換え対象の 'h2' ノードが見つかりませんでした。" . PHP_EOL;
86    }
87}
88
89// 関数を実行します。
90demonstrateDomReplaceChild();

PHPのDOMDocument::replaceChildメソッドは、HTMLやXMLドキュメント内の既存のノードを別の新しいノードで置き換える際に使用されます。このメソッドは、$newChildと$oldChildという二つのDOMNode型引数を取ります。$newChildは新しく挿入したいノードを、$oldChildは置き換えたい既存のノードをそれぞれ指定します。メソッドが成功すると、置き換えられた元の$oldChildノードを返します。これにより、どのノードが置き換えられたかを確認することができます。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、定義されたHTML文字列を読み込んでいます。次に、id="target-container"を持つdiv要素の中から、置き換え対象となるh2要素（$oldChild）を探し出します。その後、「この見出しは新しい段落に置き換えられました！」というテキストとclass="replaced-content"を持つ新しい<p>要素（$newChild）を作成します。最後に、$oldChildの親ノードに対してreplaceChildメソッドを呼び出すことで、元のh2要素が作成したp要素に置き換えられます。この操作により、DOMツリーが動的に変更され、ウェブページの特定部分をプログラムで更新するなどの処理に利用できます。

DOMDocument::replaceChildメソッドを使用する際は、まず$newChildと$oldChildがDOMNodeオブジェクトであることを確認してください。特に$oldChildはDOMツリーに既に存在し、親ノードを持つ必要があります。親ノードが存在しないノードを置き換えようとするとエラーになりますので、$oldChild->parentNodeの存在チェックは必須です。

また、このメソッドの戻り値は新しく挿入されたノードではなく、置き換えられた元のノードである点にご注意ください。目的のノードが見つからなかったり、意図しないノードを操作したりしないよう、対象ノードの取得方法と存在確認を慎重に行うことが、安全で正確なDOM操作の鍵となります。ノードの検索にはgetElementByIdだけでなく、複雑な場合はDOMXPathの利用も検討すると良いでしょう。