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

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

作成日: 2025年09月11日更新日: 2025年12月04日

基本的な使い方

replaceChildメソッドは、DOMNotationノードの子ノードを新しいノードで置き換えるメソッドです。DOM (Document Object Model) は、HTMLやXMLドキュメントをプログラムから操作するためのインターフェースであり、ノードはドキュメントを構成する要素、属性、テキストなどを指します。DOMNotationノードは、DTD (Document Type Definition) で宣言されたnotationを表します。

このメソッドは、既存の子ノードを別のノードで置き換える場合に利用されます。具体的には、$newnode で指定された新しいノードを、$oldnode で指定された既存のノードの代わりに挿入します。$oldnode は、置換対象となるDOMNotationノードの子ノードでなければなりません。もし $oldnode が親ノードの子ノードでなければ、DOM_HIERARCHY_REQUEST_ERR という例外が発生します。

replaceChildメソッドは、ノードの構造を動的に変更するために不可欠な機能を提供します。例えば、ドキュメントの特定の要素を新しい要素で更新したり、不要になった要素を削除して別の要素に置き換えたりする際に使用できます。メソッドの実行後、$oldnode はドキュメントから削除され、$newnode が $oldnode の位置に挿入されます。$newnode が既にドキュメント内に存在する場合、$newnode はドキュメントから削除され、新しい位置に移動します。

構文(syntax)


1DOMNotation::replaceChild(DOMNode $newChild, DOMNode $oldChild): DOMNode

引数(parameters)

DOMNode $newChild, DOMNode $oldChild

DOMNode $newChild: 現在のノードの代わりに挿入する新しい子ノード
DOMNode $oldChild: 置き換えられる既存の子ノード

戻り値(return)

DOMNode

指定されたノードを、指定された位置にあった子ノードと置き換えた結果として、置き換えられた古い子ノードを返します。

サンプルコード

PHP DOMDocument replaceChildで要素を置き換える


1<?php
2/**
3 * DOMElementの子ノードを置き換えるサンプルコード
4 */
5function replaceDomElementExample(): void
6{
7    // 操作対象のHTML文字列
8    $htmlString = <<<HTML
9    <!DOCTYPE html>
10    <html lang="ja">
11    <head>
12        <meta charset="UTF-8">
13        <title>DOMDocument replaceChild Example</title>
14    </head>
15    <body>
16        <div id="container">
17            <p id="target">これは置き換えられる前の段落です。</p>
18            <span>この要素は変更されません。</span>
19        </div>
20    </body>
21    </html>
22    HTML;
23
24    // DOMDocumentオブジェクトを生成
25    $dom = new DOMDocument();
26
27    // HTML文字列を読み込む (HTML5のタグで警告が出ないようにエラー出力を抑制)
28    @$dom->loadHTML($htmlString, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
29
30    // 置き換え対象の古いノードを取得 (id="target")
31    $oldChild = $dom->getElementById('target');
32
33    // 新しく挿入するノードを作成 (<h2>要素)
34    $newChild = $dom->createElement('h2', 'これは新しく置き換えられた見出しです。');
35
36    // 親ノードが存在し、置き換え対象のノードが見つかった場合のみ処理を実行
37    if ($oldChild && $oldChild->parentNode) {
38        // 親ノードの replaceChild メソッドを呼び出し、ノードを置き換える
39        // 第1引数: 新しいノード
40        // 第2引数: 置き換える古いノード
41        $oldChild->parentNode->replaceChild($newChild, $oldChild);
42    }
43
44    // 整形してHTMLを出力
45    $dom->formatOutput = true;
46    echo $dom->saveHTML();
47}
48
49// 関数を実行
50replaceDomElementExample();

このPHPサンプルコードは、DOMDocumentクラスを利用してHTMLドキュメント内の特定の子ノードを、別の新しいノードに置き換える方法を示しています。

中心となるのはreplaceChildメソッドです。このメソッドは、ある親ノードが持つ子ノードを、新しく作成したノードで置き換えるために使用します。メソッドは置き換えたいノードの親ノードオブジェクトから呼び出す必要があります。

replaceChildメソッドは2つの引数を取ります。第1引数には、新しく挿入するノードを指定します。サンプルコードではcreateElementで作成された<h2>要素がこれにあたります。第2引数には、置き換え対象となる既存の子ノードを指定します。サンプルではgetElementByIdで取得した<p>要素が該当します。メソッドの戻り値として、置き換えられて削除された古いノードが返されます。

コードの処理の流れは、まずHTML文字列をDOMDocumentに読み込み、解析します。次に、置き換えたい要素（<p id="target">）を取得し、新しく挿入する<h2>要素を作成します。そして、置き換え対象要素の親ノードに対してreplaceChildメソッドを呼び出すことで、指定した<p>要素が<h2>要素に置き換えられます。最後にsaveHTMLメソッドで、変更が反映されたHTML全体を出力しています。

replaceChildメソッドは、置き換える対象のノード自身からではなく、その親ノードから呼び出す必要がある点に注意してください。サンプルコードのように、処理を実行する前に対象ノードとその親ノードが存在するかをif文で確認することは、対象が見つからなかった場合のエラーを防ぐための重要な記述です。また、getElementByIdは文書の形式によっては期待通りに機能しない場合があるため、より確実な要素の特定にはDOMXPathの利用も有効です。@を使ったエラー抑制は、予期せぬエラーも見逃す可能性があるため慎重に利用しましょう。新しく作成するノードは、必ず操作対象と同じDOMDocumentインスタンスから生成する必要があります。

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


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMElementのreplaceChildメソッドを使用して子ノードを置き換えるサンプルコードです。
7 *
8 * DOMNotationノードは子ノードを持つことができないため、replaceChildは実質的に使用できません。
9 * そのため、このサンプルでは一般的な使用例として、DOMElementでreplaceChildメソッドの
10 * 使い方を分かりやすく示します。
11 */
12function demonstrateDomElementReplaceChild(): void
13{
14    // 操作対象のXML文字列を定義します
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="utf-8"?>
17<book>
18    <title>古いタイトル</title>
19    <author>作者名</author>
20</book>
21XML;
22
23    // DOMDocumentオブジェクトを生成し、XMLを読み込みます
24    $dom = new DOMDocument();
25    $dom->loadXML($xmlString);
26
27    // 親ノードとなる<book>要素を取得します
28    $bookElement = $dom->getElementsByTagName('book')->item(0);
29
30    // 置き換え対象となる古い子ノード<title>を取得します
31    $oldTitleElement = $dom->getElementsByTagName('title')->item(0);
32
33    // 置き換え後の新しい子ノード<title>を作成します
34    $newTitleElement = $dom->createElement('title', '新しいタイトル');
35
36    if ($bookElement && $oldTitleElement) {
37        // <book>要素の古い子ノード($oldTitleElement)を
38        // 新しい子ノード($newTitleElement)に置き換えます
39        $replacedNode = $bookElement->replaceChild($newTitleElement, $oldTitleElement);
40        
41        // 置き換えられて削除されたノードの情報を出力します
42        echo '置き換えられたノード: <' . $replacedNode->nodeName . '>' . $replacedNode->nodeValue . '</' . $replacedNode->nodeName . '>' . PHP_EOL;
43    }
44
45    // 整形してXMLを出力します
46    $dom->formatOutput = true;
47    echo $dom->saveXML();
48}
49
50// 関数を実行します
51demonstrateDomElementReplaceChild();
52

DOMNotation::replaceChildは、子ノードを置き換えるためのメソッドです。しかし、DOMNotationは仕様上、子ノードを持つことができないため、このメソッドをDOMNotationオブジェクトに対して呼び出すとエラーとなり、実質的に使用できません。

そのため、このサンプルコードでは、より一般的なDOMElementクラスを例に、replaceChildメソッドの基本的な使い方を解説しています。

コードでは、まずXML文字列をDOMDocumentオブジェクトとして読み込みます。次に、親となる<book>要素と、置き換え対象である古い<title>要素を取得し、createElementで新しい<title>要素を作成します。

replaceChildメソッドは、第1引数に新しく挿入するノード（$newChild）、第2引数に置き換えて削除する既存の子ノード（$oldChild）を指定します。このメソッドを実行すると、親ノード（<book>）の子である古い<title>要素が、新しく作成した<title>要素に置き換えられます。

このメソッドの戻り値は、置き換えによって削除された古いノード（$oldChild）です。サンプルでは、この戻り値を利用して、どのノードが置き換えられたかを出力で確認しています。最後に、saveXMLメソッドで変更が反映されたXML全体を出力し、ノードの置き換えが成功したことを示します。

replaceChildメソッドは、指定した子ノードを新しいノードに置き換えます。注意点として、getElementsByTagNameでノードを取得する際、要素が見つからないとnullが返るため、サンプルコードのようにif文などで必ず存在を確認してから処理を実行してください。replaceChildの第一引数には新しいノード、第二引数に置き換える古いノードを指定します。この順序は重要なので間違えないようにしましょう。また、このメソッドの戻り値は追加された新しいノードではなく、置き換えられて削除された「古いノード」です。これを利用して、削除したノードの情報を確認できます。なお、サンプルはDOMElementでの使用例ですが、リファレンスのDOMNotationは子ノードを持てないため、このメソッドは事実上使用できません。