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

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

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

基本的な使い方

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

このメソッドは、以下の手順で動作します。まず、置き換え対象となる古いノード（oldNode）と、新しく挿入するノード（newNode）を受け取ります。次に、Notationノードの子ノードリスト内でoldNodeを検索します。oldNodeが見つかった場合、それをnewNodeで置き換えます。置き換えが成功すると、oldNodeはドキュメントツリーから削除され、newNodeが代わりに挿入されます。oldNodeが見つからない場合は、例外が発生します。

replaceChildメソッドは、DOMツリーの構造を動的に変更する際に非常に役立ちます。例えば、XMLドキュメントの内容をプログラムによって変更し、特定のノードを新しい内容で更新する場合などに使用されます。このメソッドを使用することで、開発者は柔軟かつ効率的にドキュメントの構造を操作できます。

メソッドの呼び出しには、置き換える対象となるノードと、新しく挿入するノードの2つの引数を指定する必要があります。メソッドが正常に完了すると、置き換えられた古いノードが返されます。エラーが発生した場合は、適切な例外がスローされます。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$dom->loadXML('<root><node id="1">old node</node></root>');
4
5$oldNode = $dom->getElementById('1');
6
7$newNode = $dom->createElement('node');
8$newNode->setAttribute('id', '2');
9$newNode->textContent = 'new node';
10
11$notation = $dom->createNotation('notation_name', 'public_id', 'system_id');
12$dom->insertBefore($notation, $dom->documentElement); // NotationはDocumentElementの子として追加できないため、insertBeforeでルート要素の前に挿入
13
14// NotationノードはreplaceChildの引数として適切ではないため、createElementで作成したノードを代わりに利用
15$oldNode->parentNode->replaceChild($newNode, $oldNode);
16
17echo $dom->saveXML();
18?>

引数(parameters)

DOMNode $newChild, DOMNode $oldChild

DOMNode $newChild: 挿入する新しいノード
DOMNode $oldChild: 置き換える既存のノード

戻り値(return)

Dom\Node

指定されたノード (Dom\Node) を、現在のノード (Dom\Notation) の子ノードリストから指定された子ノード (Dom\Node) と置き換えた結果として、元のノード (Dom\Node) が返されます。

サンプルコード

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


1<?php
2
3/**
4 * DOMDocumentを使用して指定したHTML要素を新しい要素に置き換えるサンプル関数
5 *
6 * @return void
7 */
8function replaceDomElement(): void
9{
10    // 操作対象のHTML文字列を定義します
11    $html = <<<HTML
12<!DOCTYPE html>
13<html>
14<head>
15    <meta charset="UTF-8">
16    <title>DOM replaceChild サンプル</title>
17</head>
18<body>
19    <div id="container">
20        <h1>元の見出し</h1>
21        <p id="target">この段落が置き換えられます。</p>
22        <span>これは残ります。</span>
23    </div>
24</body>
25</html>
26HTML;
27
28    // DOMDocumentオブジェクトをインスタンス化します
29    $dom = new DOMDocument();
30
31    // HTMLを読み込みます。エラーを抑制するために@を使用することがあります。
32    // LIBXML_NOERROR と LIBXML_NOWARNING を使うと、HTML5のタグなどでのパースエラーを抑制できます。
33    @$dom->loadHTML($html, LIBXML_NOERROR | LIBXML_NOWARNING);
34
35    // 置き換え対象の古いノード（<p id="target">）を取得します
36    $oldChild = $dom->getElementById('target');
37
38    // 親ノードが存在しない場合は処理を中断します
39    if ($oldChild === null || $oldChild->parentNode === null) {
40        echo "対象の要素が見つかりませんでした。";
41        return;
42    }
43
44    // 置き換えるための新しいノード（<h2>）を作成します
45    $newChild = $dom->createElement('h2', '新しい見出しに置き換えられました。');
46    // 新しいノードに属性を追加します
47    $newChild->setAttribute('class', 'highlight');
48
49    // 親ノード（<div id="container">）を取得し、replaceChildメソッドを実行します
50    // 第1引数に新しいノード、第2引数に古いノードを指定します
51    $oldChild->parentNode->replaceChild($newChild, $oldChild);
52
53    // 変更後のHTMLを出力します
54    echo $dom->saveHTML();
55}
56
57// 関数を実行します
58replaceDomElement();
59
60?>

このPHPサンプルコードは、DOMDocumentクラスを利用してHTML文書内にある特定の要素を、新しく作成した別の要素に置き換える方法を示しています。まず、DOMDocumentオブジェクトを生成し、loadHTMLメソッドでHTML文字列を解析してDOMツリーを構築します。次に、getElementByIdメソッドを使って置き換え対象となる<p id="target">要素を取得します。続いて、createElementメソッドで新しい<h2>要素を作成し、setAttributeで属性を追加します。

中心となる処理はreplaceChildメソッドです。このメソッドは、ある親ノードが持つ子ノードを、別のノードに置き換えるために使用します。第1引数には新しく挿入するノードを、第2引数には置き換えたい既存の子ノードを指定します。メソッドを実行すると、置き換えられて削除された古いノードが戻り値として返されます。このサンプルでは、対象要素の親ノード（$oldChild->parentNode）からこのメソッドを呼び出し、<p>要素を新しく作成した<h2>要素に置き換えています。最後にsaveHTMLメソッドで、変更が適用されたHTML全体を出力しています。

loadHTMLメソッドで@や定数を使うのは、HTMLの仕様に厳密でない記述があった際のエラー発生を抑制するためです。また、getElementByIdが正しく機能するには、読み込むHTMLにDOCTYPE宣言が含まれている必要があります。要素が見つからなかった場合に備え、処理を実行する前に必ずnullチェックを行うことで、エラーを未然に防げます。replaceChildは、置き換え対象要素の親ノードから呼び出すメソッドです。第1引数に新しい要素、第2引数に置き換えたい古い要素を指定する順序も間違えないようにしましょう。新しく作成する要素は、操作しているDOMDocumentオブジェクト自身で作成されたノードである必要があります。