【PHP8.x】replaceChildメソッドの使い方

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

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

基本的な使い方

replaceChildメソッドは、PHPのDOM（Document Object Model）拡張機能において、ドキュメントツリー内の既存の子ノードを新しい子ノードで置き換える処理を実行するメソッドです。

このメソッドはDOMCharacterDataクラスに属していますが、実際にはその親クラスであるDOMNodeから継承されており、WebページやXMLファイルなどの構造をオブジェクトとして表現し、プログラムから操作するためのDOMツリーを扱う上で重要な機能を提供します。DOMCharacterDataクラス自体は、テキストデータ、コメント、CDATAセクションといった文字データを保持するノードの基底クラスです。このクラスに属するオブジェクトも、DOMツリー内のノードの置き換え操作にこのメソッドを利用することができます。

具体的には、このメソッドは二つの引数を取ります。一つ目の$newChildには新しく挿入したいノードオブジェクトを、二つ目の$oldChildには置き換えたい既存の子ノードオブジェクトを指定します。実行されると、$oldChildがあった位置に$newChildが挿入され、$oldChildはドキュメントツリーから削除されます。

このメソッドは、置き換えられた$oldChildノードを戻り値として返します。これにより、ドキュメントツリーから削除されたノードに対して、必要に応じて後続の処理を行ったり、別の場所に再挿入したりすることが可能になります。

Webサイトの動的な内容更新や、XML設定ファイルの特定の要素の値をプログラム的に変更するなど、DOMツリーの構造や内容を柔軟に操作したい場合に、このreplaceChildメソッドは非常に役立ちます。

構文(syntax)


1<?php
2
3$document = new DOMDocument();
4$document->loadXML('<root><old_child/></root>');
5
6$parent = $document->documentElement;
7$oldNode = $parent->firstChild;
8
9$newNode = $document->createElement('new_child');
10
11// $oldNode を $newNode で置き換える
12$parent->replaceChild($newNode, $oldNode);
13
14echo $document->saveXML();
15
16?>

引数(parameters)

DOMNode $newnode, DOMNode $oldnode

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

戻り値(return)

DOMNode

replaceChildメソッドは、指定した子ノードを新しいノードで置き換えた結果として、置き換えられた古い子ノードをDOMNodeオブジェクトとして返します。

サンプルコード

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


1<?php
2
3// 新しいノードで古いノードを置き換えるサンプル
4$dom = new DOMDocument();
5$dom->loadXML('<root><child>Old Content</child></root>');
6
7$oldNode = $dom->getElementsByTagName('child')->item(0);
8
9// 新しいノードを作成
10$newNode = $dom->createElement('child');
11$newNode->textContent = 'New Content';
12
13// 古いノードを新しいノードで置き換える
14$replacedNode = $oldNode->parentNode->replaceChild($newNode, $oldNode);
15
16// 結果を出力
17echo $dom->saveXML();
18
19?>

PHP 8のDOMCharacterDataクラスにおけるreplaceChildメソッドは、DOMドキュメント内のノードを別のノードで置き換えるために使用します。このメソッドは、特にXMLドキュメントの構造を動的に変更する際に役立ちます。

replaceChildメソッドは、DOMNode型の$newnode（新しいノード）と$oldnode（古いノード）の2つの引数を取ります。$newnodeは、$oldnodeと置き換わる新しいノードを指定します。$oldnodeは、置き換えられる既存のノードを指定します。

このメソッドは、置き換えられたノード（元の$oldnode）をDOMNode型で返します。もし指定された$oldnodeが親ノードの子ノードでない場合、またはエラーが発生した場合は、NULLを返します。

上記のサンプルコードでは、まずDOMDocumentオブジェクトを作成し、XML文字列をロードしています。次に、getElementsByTagNameメソッドで"child"というタグ名の要素を取得し、item(0)で最初の要素（$oldNode）を選択しています。

新しいノード($newNode)をcreateElementメソッドで作成し、textContentプロパティに新しいコンテンツを設定しています。

そして、$oldNodeの親ノードに対してreplaceChildメソッドを呼び出し、$newNodeで$oldNodeを置き換えています。replaceChildメソッドは、置き換えられたノードを返しますが、ここでは結果を変数に格納しています。

最後に、saveXMLメソッドで変更後のXMLドキュメントを出力しています。これにより、"Old Content"が"New Content"に置き換わったXMLドキュメントが表示されます。このメソッドを利用することで、XMLドキュメントの特定の部分を効率的に更新することができます。

DOMCharacterData::replaceChild ではなく、DOMNode::replaceChild メソッドの解説です。サンプルコードでは、$oldNode->parentNode に対して replaceChild を実行している点に注意してください。replaceChild は、置き換えられるノードの親ノードのメソッドとして呼び出す必要があります。$oldNode 自体には replaceChild メソッドは存在しません。また、$oldNode がドキュメントに存在しない場合、エラーが発生します。$newNode は $dom によって作成されたノードである必要があります。異なる DOMDocument に属するノードを置き換えることはできません。戻り値は置き換えられた $oldnode です。