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

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

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

基本的な使い方

replaceChildメソッドは、PHPのDOM拡張機能において、あるノードの既存の子ノードを新しい子ノードで置き換えることを実行するメソッドです。このメソッドは通常、DOMNodeクラスに定義されており、HTMLやXMLドキュメントのツリー構造を操作する際に利用されます。

しかし、本メソッドが所属するDOMTextクラスは、ドキュメント内の純粋なテキストデータ、つまり文字の連なりを表現するノードであり、他のDOMElementのような要素ノードとは異なり、自身の子ノードを持つことはできません。DOMTextインスタンスは常に葉ノード（末端のノード）とみなされます。

そのため、DOMTextのインスタンスに対してreplaceChildメソッドを呼び出し、子ノードを置き換えようと試みると、DOMツリーの階層構造のルールに反する操作とみなされます。具体的には、テキストノードは子ノードを持つことができないという制約に違反するため、このメソッドの実行は常に失敗します。

結果として、DOMText::replaceChildメソッドを呼び出すと、常にDOM_HIERARCHY_REQUEST_ERRという種類のDOM例外がスローされます。この例外は、指定されたノードの種類が、呼び出し元のノードの子として許可されていない場合に発生するものであり、DOMTextが子ノードを持てないという性質から、このエラーを避けることはできません。したがって、このメソッドはDOMTextのコンテキストでは、意図しない階層操作を検出するためのものとして機能します。

構文(syntax)


1<?php
2
3$domTextObject = new DOMText("Original Text");
4$newChildNode = new DOMElement("span");
5$oldChildNode = new DOMText("Placeholder Text");
6
7$replacedNode = $domTextObject->replaceChild($newChildNode, $oldChildNode);

引数(parameters)

DOMNode $new_node, DOMNode $old_node

DOMNode $new_node: 置換後の新しいノード
DOMNode $old_node: 置換される古いノード

戻り値(return)

DOMNode

指定されたノードを現在のノードの子ノードと置き換えた場合、置き換えられた（元の）子ノードを返します。

サンプルコード

PHP DOMDocument replaceChildでテキストノードを置き換える


1<?php
2
3/**
4 * DOMElementの子ノードであるDOMTextノードを、新しいDOMTextノードに置き換えるサンプルコードです。
5 *
6 * PHPのDOMTextクラスは子ノードを持たないため、replaceChildメソッドはDOMTextの親ノードに対して呼び出されます。
7 * この例では、<p>要素の子である既存のテキストノードを、新しいテキストノードに置き換える方法を示します。
8 * replaceChildメソッドは、置き換えられた古いノードを返します。
9 */
10
11// 新しいDOMDocumentを作成
12$dom = new DOMDocument('1.0', 'UTF-8');
13$dom->formatOutput = true; // 整形して出力することで、可読性を高めます
14
15// ルート要素 <div> を作成し、ドキュメントに追加
16$rootElement = $dom->createElement('div');
17$dom->appendChild($rootElement);
18
19// <p>要素を作成し、<div>の子として追加
20$paragraphElement = $dom->createElement('p');
21$rootElement->appendChild($paragraphElement);
22
23// 最初のDOMTextノードを作成し、<p>の子として追加
24$oldTextNode = $dom->createTextNode('これは元のテキストです。');
25$paragraphElement->appendChild($oldTextNode);
26
27echo "--- 置き換え前 ---" . PHP_EOL;
28// 現在のDOM構造をHTML形式で出力
29echo $dom->saveHTML() . PHP_EOL;
30
31// 新しいDOMTextノードを作成
32$newTextNode = $dom->createTextNode('これは置き換えられた新しいテキストです！');
33
34// $paragraphElement の子ノードである $oldTextNode を $newTextNode で置き換え
35// replaceChildメソッドは、置き換えられた古いノード ($oldTextNode) を返します。
36$replacedNode = $paragraphElement->replaceChild($newTextNode, $oldTextNode);
37
38echo "--- 置き換え後 ---" . PHP_EOL;
39// 変更後のDOM構造をHTML形式で出力
40echo $dom->saveHTML() . PHP_EOL;
41
42// 置き換えられたノードが実際に$oldTextNodeと同じオブジェクトであることを確認 (オプション)
43if ($replacedNode === $oldTextNode) {
44    echo PHP_EOL . "元のテキストノードが正しく置き換えられ、そのオブジェクトが返されました。" . PHP_EOL;
45}
46
47?>

PHPのreplaceChildメソッドは、DOMツリー内の既存のノードを新しいノードで置き換える際に使用されます。このメソッドは、子ノードを持つことができるノード、つまり親ノードに対して呼び出されます。DOMTextノード自体は子ノードを持たないため、DOMText::replaceChildとリファレンスにありますが、実際にはDOMTextノードの親要素（例えばDOMElement）に対して呼び出すことで、そのテキストノードを置き換えます。

第一引数DOMNode $new_nodeには、既存のノードと置き換える新しいノードを指定します。第二引数DOMNode $old_nodeには、置き換えられる既存のノードを指定します。このメソッドは、置き換えられた古いノードをDOMNodeとして戻り値で返します。

サンプルコードでは、まずDOMDocumentを作成し、<div>と<p>要素を追加します。次に「これは元のテキストです。」という内容のDOMTextノードを作成し、<p>要素の子として追加します。その後、「これは置き換えられた新しいテキストです！」という新しいDOMTextノードを作成し、<p>要素のreplaceChildメソッドを使って元のテキストノードと置き換えています。これにより、<p>タグ内のテキスト内容が変更され、HTMLの出力結果にその変化が反映されます。メソッドの戻り値が置き換えられた元のテキストノードであることも確認できます。

PHPのDOMText::replaceChildメソッドは、DOMTextノードそのものではなく、その親となるDOMElementなどの要素ノードから呼び出す点が特に重要です。引数の順序は、まず新しいノード、次に置き換えたい古いノードとなります。置き換え対象の古いノードは、必ずメソッドを呼び出す親ノードの子である必要がありますので、事前にノードの親子関係をしっかり確認してください。このメソッドの戻り値は、置き換えられた古いノード自身です。DOM操作は複雑になりがちですので、saveHTML()などを使って変更前後のDOM構造を確認しながら進めることをお勧めします。