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

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

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

基本的な使い方

replaceChildメソッドは、指定されたノード（親ノード）の子ノードリスト内において、既存の特定の子ノードを新しいノードで置き換える役割を持つメソッドです。

このメソッドが属するDOMAttrクラスは、HTMLやXMLドキュメントにおいて、要素の属性、例えば<div id="myId">におけるid属性などを表現するためのオブジェクトです。DOMAttrノードは、DOMNodeという共通の基底クラスを継承しているため、replaceChildメソッドも利用できます。

しかしながら、DOMAttrノードは、その性質上、通常は属性値であるテキストノードのみを子ノードとして持ちます。一般的なDOMノードのように、複数の異なる種類の子ノードを持つことはありません。そのため、DOMAttrインスタンスに対してreplaceChildメソッドを呼び出すことは、非常に特殊な状況に限られます。

例えば、DOMAttrが持つテキストノード（属性値）を別のテキストノードで置き換えることは技術的に可能ですが、通常、属性値を変更する場合はDOMAttrオブジェクトのvalueプロパティを直接設定する方が一般的で推奨される方法です。replaceChildメソッドをDOMAttrに対して誤って使用した場合、子ノードが存在しない、または期待される子ノードの種類と異なるなどの理由でDOMExceptionが発生する可能性が高いです。

システムエンジニアを目指す初心者の方には、DOMAttrの特性を理解し、このメソッドがDOMAttrの文脈で通常は利用されないことを覚えておくことをお勧めします。DOM操作では、ノードの種類に応じた適切なメソッドを選択することが重要です。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$element = $dom->createElement('element_tag');
4$dom->appendChild($element);
5
6$attribute = $dom->createAttribute('attribute_name');
7$attribute->value = 'initial_value';
8$element->appendChild($attribute);
9
10$oldChildNode = $attribute->firstChild;
11$newChildNode = $dom->createTextNode('new_value');
12
13$replacedNode = $attribute->replaceChild($newChildNode, $oldChildNode);
14?>

引数(parameters)

DOMNode $newChild, DOMNode $oldChild

DOMNode $newChild: 挿入する新しい子ノードを指定します。
DOMNode $oldChild: 置換する既存の子ノードを指定します。

戻り値(return)

DOMNode

指定された要素ノードを、この属性ノードの子ノードとして置換した結果のDOMNodeオブジェクトを返します。

サンプルコード

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


1<?php
2
3/**
4 * DOMDocument を使用して XML ツリー内の要素の子ノードを置き換えるサンプルです。
5 * DOMAttr は子ノードを持たないため、replaceChild メソッドはDOMElementなど
6 * 子ノードを持つ DOMNode に対して適用されます。
7 */
8function demonstrateDomNodeReplaceChild(): void
9{
10    // 新しい DOMDocument インスタンスを作成し、XML宣言を設定
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->formatOutput = true; // 出力を見やすく整形
13
14    // ルート要素 'root' を作成し、ドキュメントに追加
15    $rootElement = $dom->createElement('root');
16    $dom->appendChild($rootElement);
17
18    // DOMAttr インスタンスを作成し、ルート要素に属性として追加します。
19    // DOMAttr は DOMNode を継承していますが、子ノードを持てないため、
20    // replaceChild メソッドの直接の親ノードとしては機能しません。
21    $idAttr = $dom->createAttribute('id');
22    $idAttr->value = 'main-id';
23    $rootElement->setAttributeNode($idAttr);
24
25    // 既存の子要素 'oldChildElement' を作成し、ルート要素に追加
26    $oldChildElement = $dom->createElement('oldChildElement', 'これは古い子要素です。');
27    $rootElement->appendChild($oldChildElement);
28
29    // 別の既存の子要素 'anotherChild' を作成し、ルート要素に追加
30    $anotherChild = $dom->createElement('anotherChild', 'これは別の子要素です。');
31    $rootElement->appendChild($anotherChild);
32
33    // 新しい子要素 'newChildElement' を作成
34    $newChildElement = $dom->createElement('newChildElement', 'これは新しい子要素です。');
35
36    echo "--- 置き換え前の XML ---" . PHP_EOL;
37    echo $dom->saveXML() . PHP_EOL;
38
39    // rootElement の子ノード oldChildElement を newChildElement で置き換える
40    // replaceChild メソッドは、置き換えられた (DOM ツリーから削除された) ノードを返します。
41    $replacedNode = $rootElement->replaceChild($newChildElement, $oldChildElement);
42
43    echo "置き換えられたノードのタグ名: " . $replacedNode->nodeName . PHP_EOL . PHP_EOL;
44
45    echo "--- 置き換え後の XML ---" . PHP_EOL;
46    echo $dom->saveXML() . PHP_EOL;
47}
48
49// サンプル関数を実行
50demonstrateDomNodeReplaceChild();

PHPのDOM拡張機能の一つであるreplaceChildメソッドは、XMLドキュメントのツリー構造において、既存の子ノードを新しい子ノードで置き換える際に使用されます。このメソッドはDOMNodeクラスで定義されており、子ノードを持つことができるDOMElementなどのインスタンスに対して適用されます。DOMAttrは属性ノードであり子ノードを持たないため、DOMAttrオブジェクト自体でreplaceChildを直接呼び出すことはありません。

引数には、新しく追加したいノードを$newChildとして、置き換えたい既存の子ノードを$oldChildとして渡します。この際、$oldChildは呼び出し元のノードの子ノードでなければなりません。メソッドが正常に実行されると、置き換えられてXMLツリーから削除された$oldChildノードが戻り値として返されます。

提供されたサンプルコードでは、DOMDocumentを使用してXML構造を作成し、root要素に属するoldChildElementという既存の子要素を、新しく作成したnewChildElementで置き換える一連の流れを示しています。これにより、XMLドキュメント内のノードがどのように動的に変更されるか、置き換え前後のXML出力で確認することができます。この機能は、XMLデータをプログラムで操作する際に、特定の要素の内容を更新したい場合に非常に便利です。

DOMNode::replaceChildメソッドは、親ノードの既存の子ノードを新しいノードで置き換える際に使用します。システムエンジニアを目指す初心者が注意すべき点は、リファレンス情報にDOMAttrとありますが、DOMAttrは子ノードを持てないため、このメソッドを直接適用することはできません。サンプルコードではDOMElementの子ノードを置き換えており、これが正しい使用例です。

置き換え対象の$oldChildは、必ず呼び出し元のノードの既存の子ノードである必要があります。存在しない子ノードを指定するとエラーが発生しますのでご注意ください。また、replaceChildメソッドは、ツリーから削除された古い子ノードを戻り値として返します。これにより、置き換えられたノードを後で利用するなどの処理が可能となります。XMLツリーの構造変更時は、意図しない副作用を防ぐため、事前に既存のツリー構造をよく理解することが安全な利用に繋がります。