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

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

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

基本的な使い方

replaceChildメソッドは、指定された子ノードを新しいノードで置き換えるメソッドです。

このメソッドは、PHPのDOM拡張機能におけるDOMDocumentFragmentクラスに属しています。DOMDocumentFragmentは、XMLやHTMLの複数のノードを一時的にまとめて扱うための軽量なコンテナとして機能します。これは、実際のDOMツリーに直接追加する前に、複数のノードを操作したり生成したりする際に非常に便利な概念です。

replaceChildメソッドを使用すると、このDOMDocumentFragmentオブジェクトが保持する子ノードのうち、特定の既存の子ノードを別の新しい子ノードに差し替えることができます。具体的には、メソッドの第一引数に「新しく追加したいノード」を、第二引数に「置き換えたい既存の子ノード」を指定します。この「置き換えたい既存の子ノード」は、メソッドを呼び出すDOMDocumentFragmentの直接の子である必要があります。もしそうでない場合や、ノードの階層に不整合がある場合はエラーが発生する可能性があります。

メソッドは、置き換えられた古いノードを戻り値として返します。この機能は、ウェブページなどの動的なコンテンツを操作する際に、既存の要素を別の要素で置き換えたり、DOMツリーの構造を柔軟に変更したりする場面で役立ちます。例えば、表示されているリストアイテムを別の内容のアイテムに差し替える、といった用途に利用できます。このメソッドを使うことで、DOMツリーを効率的に更新し、プログラムによってインタラクティブなユーザーインターフェースを構築する基礎となります。

構文(syntax)


1<?php
2
3// DOMDocumentオブジェクトを作成（ノードを作成するために必要）
4$dom = new DOMDocument();
5
6// DOMDocumentFragmentオブジェクトを作成
7$fragment = $dom->createDocumentFragment();
8
9// フラグメント内に子ノードを作成し追加（これを置き換え対象とする）
10$oldChild = $dom->createElement('span', '古いテキスト');
11$fragment->appendChild($oldChild);
12
13// 置き換えるための新しい子ノードを作成
14$newChild = $dom->createElement('strong', '新しいテキスト');
15
16// DOMDocumentFragmentの子ノードを置き換える
17// 構文: $fragment->replaceChild(DOMNode $newChild, DOMNode $oldChild);
18// 戻り値は置き換えられた（削除された）DOMNodeオブジェクト ($oldChild)
19$removedChild = $fragment->replaceChild($newChild, $oldChild);
20
21?>

引数(parameters)

DOMNode $node, DOMNode $child

DOMNode $node: 置き換えたい既存の子ノードを指定します。
DOMNode $child: $node を置き換える新しいノードを指定します。

戻り値(return)

DOMNode

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

サンプルコード

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


1<?php
2
3// DOMDocumentFragment の replaceChild メソッドの例
4
5// 新しいノードを作成
6$newNodeValue = '新しいテキスト';
7$newNode = new DOMText($newNodeValue);
8
9// 古いノードを置き換えるための親ノードを作成
10$dom = new DOMDocument();
11$fragment = $dom->createDocumentFragment();
12$oldNodeValue = '古いテキスト';
13$oldNode = $dom->createTextNode($oldNodeValue);
14$fragment->appendChild($oldNode);
15
16// 古いノードを新しいノードで置き換える
17$replacedNode = $fragment->replaceChild($newNode, $oldNode);
18
19// 結果の確認（テキストとして出力）
20echo $fragment->textContent . PHP_EOL;
21
22// 置き換えられたノードの確認
23echo $replacedNode->textContent . PHP_EOL;

PHPのDOMDocumentFragmentクラスのreplaceChildメソッドは、ドキュメントフラグメント内の子ノードを別のノードで置き換えるために使用します。

この例では、まず新しいテキストノード $newNode を作成し、置き換え対象となる古いテキストノード $oldNode を持つDOMDocumentFragment $fragment を作成しています。

$fragment->replaceChild($newNode, $oldNode) を実行することで、$fragment 内の $oldNode が $newNode に置き換えられます。replaceChild メソッドは、置き換えられたノード（この場合は $oldNode）を返します。

引数 $node には、新しく挿入するノードを指定します。引数 $child には、置き換えられる既存の子ノードを指定します。replaceChild メソッドは、置き換えられたノードを返します。もし $child が $fragment の子ノードでなければ、エラーが発生します。

上記のコードを実行すると、まず $fragment の内容として「新しいテキスト」が出力されます。これは $oldNode が $newNode に置き換えられた結果です。次に、$replacedNode の内容として「古いテキスト」が出力されます。これは、replaceChild メソッドが置き換えられた $oldNode を返しているためです。replaceChild メソッドは、DOMDocumentFragment内のノードを効率的に更新する際に役立ちます。

DOMDocumentFragment::replaceChildメソッドは、ドキュメントフラグメント内の子ノードを新しいノードで置き換えます。引数 $node には置き換える新しいノード、$child には置き換えられる既存のノードを指定します。

注意点として、$child が $fragment の直接の子ノードでない場合、エラーが発生します。また、$node は $fragment に追加される前に、ドキュメントにインポートする必要がある場合があります（特に異なるドキュメントで作成されたノードの場合）。replaceChild は置き換えられたノードを返します。サンプルコードでは、textContent を使用してノードの内容を確認していますが、XML構造全体を扱う場合は、saveXML などのメソッドを使用する必要があります。

PHP DOMDocumentFragment::replaceChildでノードを置換する


1<?php
2
3// DOMDocumentFragment::replaceChild のサンプルコード
4
5// 新しいノードと古いノードを作成
6$dom = new DOMDocument();
7$fragment = $dom->createDocumentFragment();
8$oldNode = $dom->createElement('old');
9$newNode = $dom->createElement('new');
10
11// フラグメントに古いノードを追加
12$fragment->appendChild($oldNode);
13
14// フラグメント内の古いノードを新しいノードで置換
15$replacedNode = $fragment->replaceChild($newNode, $oldNode);
16
17// 置換されたノードを出力
18echo $replacedNode->nodeName . PHP_EOL; // old
19
20// フラグメントの内容を出力
21echo $dom->saveXML($fragment) . PHP_EOL; // <new/>

DOMDocumentFragment::replaceChildメソッドは、DOMDocumentFragment内の子ノードを指定された新しいノードで置き換えるために使用します。このメソッドは、PHP 8で利用可能です。

引数には、まず新しいノード $node を指定します。これは、既存の子ノードと置き換わるノードです。次に、置き換えられる既存の子ノード $child を指定します。

サンプルコードでは、まずDOMDocumentオブジェクトとDOMDocumentFragmentオブジェクトを作成します。次に、createElementメソッドを使って、'old'という名前の古いノードと、'new'という名前の新しいノードを作成します。appendChildメソッドで、古いノードをフラグメントに追加します。

replaceChildメソッドを呼び出し、新しいノードで古いノードを置換します。replaceChildメソッドは、置換された（古い）ノードを返します。サンプルコードでは、返されたノードのノード名をechoで出力しています。この例では、$replacedNode->nodeNameは'old'を出力します。

最後に、saveXMLメソッドを使ってフラグメントの内容をXML形式で出力します。置換後のフラグメントの内容は<new/>となります。replaceChildメソッドを使用することで、DOMDocumentFragment内のノードを動的に変更できます。

DOMDocumentFragment::replaceChildは、ドキュメントフラグメント内の子ノードを別のノードで置き換えるメソッドです。引数 $node には新しいノード、$child には置き換えられる既存のノードを指定します。

注意点として、$child がフラグメントの子ノードでない場合、DOMException が発生します。また、replaceChild は置換された古いノードを返しますが、サンプルコードのように、そのノード名を出力する以外に特に利用用途がない場合もあります。saveXML でフラグメントの内容を確認することで、置換が正しく行われたかを検証できます。DOMDocumentFragment は、DOMツリーの一部として扱われるため、操作対象のノードが所属するドキュメントを意識する必要があります。