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

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

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

基本的な使い方

replaceChildメソッドは、既存のノードを新しいノードで置き換えるメソッドです。DOMDocumentTypeクラスに属しており、ドキュメントタイプノードの子ノードを置換するために使用されます。具体的には、replaceChildメソッドは、ドキュメントタイプノード（例えば、<!DOCTYPE html>）の子ノードである属性リスト（例えば、PUBLICやSYSTEMキーワード、DTDファイルの場所）を、新しいノードで置き換えることができます。

このメソッドは、置換される子ノードと、新しい子ノードの2つの引数を取ります。置換される子ノードは、ドキュメントタイプノードの既存の子ノードでなければなりません。新しい子ノードは、置換される子ノードの代わりに挿入されます。

replaceChildメソッドは、置換された古い子ノードを返します。もし新しいノードがドキュメントタイプノードの子ノードとして存在できない場合、またはその他の理由で置換が失敗した場合、例外が発生します。

システムエンジニアを目指す初心者の方にとって、replaceChildメソッドは、ドキュメントタイプ定義をプログラムで動的に変更する際に非常に役立ちます。例えば、特定のDOCTYPE宣言を別のDOCTYPE宣言に置き換えたり、DTDファイルの参照先を変更したりする際に利用できます。DOMDocumentTypeオブジェクトを通じて、ドキュメントタイプノードの構造を操作し、XMLやHTMLドキュメントの整合性を維持するために重要な役割を果たします。

構文(syntax)


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

引数(parameters)

DOMNode $newChild, DOMNode $oldChild

DOMNode $newChild: 置換後の新しいノードを指定します。
DOMNode $oldChild: 置換される既存のノードを指定します。

戻り値(return)

DOMNode

指定されたノードを、既存の子ノードと置き換えた結果の新しい子ノードを返します。

サンプルコード

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


1<?php
2
3/**
4 * HTML ドキュメント内の要素の子ノードを置き換えるサンプル関数。
5 *
6 * この関数は DOMNode::replaceChild の基本的な動作を示します。
7 * 提供されたリファレンス情報にある DOMDocumentType クラスも DOMNode を継承しているため、
8 * replaceChild メソッドは DOMDocumentType インスタンスでも利用可能です。
9 * しかし、DOMDocumentType ノード自体の子ノードを直接操作する実用的なケースは非常に稀です。
10 * 通常は、本サンプルのように HTML/XML ドキュメント内の要素ノードの子ノード操作に使用されます。
11 *
12 * @param string $htmlContent HTML文字列。
13 * @param string $parentElementId 子ノードを置き換える親要素のID。
14 * @param string $oldChildTag 置き換える既存の子ノードのタグ名。
15 * @param string $newChildTag 新しい子ノードのタグ名。
16 * @param string $newChildText 新しい子ノードのテキストコンテンツ。
17 * @return string 変更後のHTML文字列。親要素や子ノードが見つからない場合、
18 *                またはDOM操作エラーが発生した場合はエラーメッセージを返します。
19 * @throws DOMException DOM操作中にエラーが発生した場合、内部で捕捉しエラーメッセージを返します。
20 */
21function replaceChildInHtml(
22    string $htmlContent,
23    string $parentElementId,
24    string $oldChildTag,
25    string $newChildTag,
26    string $newChildText
27): string {
28    $dom = new DOMDocument('1.0', 'UTF-8');
29    // HTMLをロードする際のエラーを抑制（不適切なHTMLでも処理を続行するため）
30    libxml_use_internal_errors(true);
31    // LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD を使用して、
32    // HTML5 のような簡易DOCTYPEでも余分な要素が追加されるのを防ぎます。
33    $dom->loadHTML($htmlContent, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
34    libxml_clear_errors(); // ロード中に発生した警告などをクリア
35    libxml_use_internal_errors(false); // エラー抑制を解除
36
37    $parentElement = $dom->getElementById($parentElementId);
38
39    if (!$parentElement) {
40        return "エラー: ID '{$parentElementId}' の要素が見つかりません。\n";
41    }
42
43    // 置き換え対象の古い子ノードを探す
44    $oldChild = null;
45    foreach ($parentElement->childNodes as $child) {
46        // ノードが要素であり、かつ指定されたタグ名を持つものを検索
47        if ($child->nodeType === XML_ELEMENT_NODE && $child->tagName === $oldChildTag) {
48            $oldChild = $child;
49            break;
50        }
51    }
52
53    if (!$oldChild) {
54        return "エラー: 親要素 (ID: '{$parentElementId}') の中にタグ名 '{$oldChildTag}' の子ノードが見つかりません。\n";
55    }
56
57    // 新しい子ノードを作成
58    $newChild = $dom->createElement($newChildTag, $newChildText);
59
60    try {
61        // $oldChild を $newChild で置き換えます。
62        // この replaceChild メソッドは、置き換えられた (削除された) $oldChild ノードを返します。
63        $parentElement->replaceChild($newChild, $oldChild);
64    } catch (DOMException $e) {
65        // DOM 操作中にエラーが発生した場合、例外を捕捉しエラーメッセージを返します。
66        return "DOM操作エラー: " . $e->getMessage() . "\n";
67    }
68
69    // 変更後のHTMLを文字列として返します。
70    return $dom->saveHTML();
71}
72
73// --- サンプルコードの実行例 (このブロックは出力条件に従い、コメントアウトまたは削除されます) ---
74// このコードが単体で動作可能であることを示すための呼び出し例です。
75// 実際の出力ではこの部分は含まれません。
76/*
77$initialHtml = <<<HTML
78<!DOCTYPE html>
79<html>
80<head><title>DOM ReplaceChild Example</title></head>
81<body>
82    <div id="container">
83        <p>最初の段落です。</p>
84        <span>元のテキストスパン</span>
85        <p>二番目の段落です。</p>
86    </div>
87</body>
88</html>
89HTML;
90
91// 実行例: ID 'container' の要素内で、タグ名 'span' の子ノードを
92// タグ名 'strong' でテキスト '新しく追加された強調テキスト' を持つノードに置き換える
93$updatedHtml = replaceChildInHtml(
94    $initialHtml,
95    'container',
96    'span',
97    'strong',
98    '新しく追加された強調テキスト'
99);
100
101echo $updatedHtml;
102*/

PHPのDOMNode::replaceChildメソッドは、HTMLやXMLドキュメントのツリー構造において、特定の子ノードを別の新しいノードに置き換える際に使用されます。このメソッドは、指定されたDOMNodeオブジェクトの子ノードリストから、既存の$oldChildノードを削除し、その位置に$newChildノードを挿入する働きをします。

引数について、$newChildには新しく挿入したいDOMNodeを指定し、$oldChildには置き換えたい既存のDOMNodeを指定します。戻り値としては、置き換えによってドキュメントツリーから削除された$oldChildノードが返されます。

このサンプルコードでは、HTML文字列をPHPのDOMDocumentオブジェクトとして読み込み、特定のIDを持つ親要素の中から指定されたタグ名を持つ子ノードを探し、それを新しく作成したノードで置き換える具体的な例を示しています。DOMDocumentTypeクラスはDOMNodeを継承しているためreplaceChildメソッドを利用できますが、通常、このメソッドはHTML/XMLドキュメント内の一般的な要素ノードの子ノード操作で活用されることが多いです。この機能により、プログラムから動的にドキュメントの構造を変更することが可能となり、ウェブコンテンツの生成や加工に役立ちます。

replaceChildメソッドは親要素から呼び出し、子ノードを新しいノードに置き換えます。引数の順序は「新しく挿入するノード」が先、「置き換えられる既存ノード」が後ですので、指定を間違えないよう特に注意してください。また、このメソッドの戻り値は置き換えられて削除された古いノードが返されるため、戻り値の取り扱いには注意が必要です。リファレンスではDOMDocumentTypeクラスのメソッドですが、通常は本サンプルのようにDOMElementの子ノード操作に利用することがほとんどです。HTMLをパースする際、libxml_use_internal_errorsなどでエラーを抑制し、LIBXML_HTML_NOIMPLIEDオプションを使用することで、不完全なHTMLでも安定した処理が期待できます。try-catch構文を用いてDOMExceptionを捕捉し、DOM操作エラーへの対処を組み込むことは、堅牢なアプリケーションを開発する上で非常に重要です。

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


1<?php
2
3// 新しいノードと古いノードを入れ替えるサンプル
4$dom = new DOMDocument();
5$dom->loadXML('<root><node1>old node</node1><node2>another node</node2></root>');
6
7// 入れ替え対象のノードを取得
8$oldNode = $dom->getElementsByTagName('node1')->item(0);
9
10// 新しいノードを作成
11$newNode = $dom->createElement('node1', 'new node');
12
13// ノードを入れ替える
14$replacedNode = $dom->documentElement->replaceChild($newNode, $oldNode);
15
16// 結果を出力
17echo $dom->saveXML();
18
19?>

PHPのDOMDocumentTypeクラスにおけるreplaceChildメソッドは、XMLドキュメント内のノードを別のノードで置き換えるために使用します。具体的には、指定された親ノードの子ノードを、新しいノードで置き換えます。このメソッドは、DOMツリー構造を動的に変更する際に非常に役立ちます。

引数として、$newChildには置き換えに使用する新しいDOMNodeオブジェクトを、$oldChildには置き換えられる既存のDOMNodeオブジェクトを指定します。$oldChildは、親ノードの直接の子である必要があります。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、XML文字列をロードしています。次に、getElementsByTagNameメソッドを用いて、置き換え対象となる古いノード（node1）を取得しています。そして、createElementメソッドを使って、新しいノード（node1の中身が "new node"）を作成します。

replaceChildメソッドは、$dom->documentElement->replaceChild($newNode, $oldNode)のように呼び出されます。ここで$dom->documentElementは、XMLドキュメントのルート要素を取得しています。replaceChildメソッドは、置き換えられた古いノード（$oldNode）をDOMNodeオブジェクトとして返します。

最後に、saveXMLメソッドを使って、変更後のXMLドキュメントを文字列として出力します。実行結果として、<node1>old node</node1>が<node1>new node</node1>に置き換わったXML文字列が出力されます。このメソッドを使うことで、XMLドキュメントの内容をプログラムから柔軟に変更できます。

DOMDocumentType::replaceChildメソッドは、DOMDocument内のノードを別のノードで置き換える際に使用します。サンプルコードではdocumentElementに対してreplaceChildを実行していますが、これはルート要素直下のノードを置き換える例です。異なる階層のノードを置き換える場合は、適切な親ノードを指定する必要があります。

引数$newChildは、$oldChildと置き換わる新しいノードです。$oldChildは、置き換えられる古いノードです。$oldChildが存在しない場合や、$newChildがDOMDocumentに属していない場合はエラーが発生します。

戻り値は置き換えられた古いノード（$oldChild）です。この戻り値を特に利用しない場合でも、変数に格納するか、明示的に無視するようにしましょう。ノードの操作を行う際は、常にDOM構造が意図した状態になっているか確認することが重要です。