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

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

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

基本的な使い方

replaceChildメソッドは、DOM (Document Object Model) において、ある要素ノードの子ノードを、新しいノードで置き換える操作を実行するメソッドです。Dom\Elementクラスに属しており、特定の要素の子ノードを動的に変更する際に利用されます。

具体的には、replaceChildメソッドは、置き換えられる既存の子ノードと、新しく挿入されるノードの2つの引数を取ります。メソッドが呼び出される要素（親ノード）の中で、最初の子ノード引数で指定されたノードが、2番目の引数で指定された新しいノードで置き換えられます。置き換えられたノードは、DOMツリーから削除され、新しいノードがその位置に挿入されます。

replaceChildメソッドを使用する際には、以下の点に注意する必要があります。

引数として渡されるノードが、DOMツリー内で有効なノードである必要があります。
新しいノードを挿入する前に、そのノードがドキュメントに適切に作成されている必要があります。
置き換えるノードが、メソッドを呼び出す要素の直接の子ノードである必要があります。

replaceChildメソッドは、DOM構造を動的に変更するための強力なツールであり、ウェブページのコンテンツをインタラクティブに変更する際などに役立ちます。例えば、特定条件に基づいて要素の内容を更新したり、要素の構造を動的に変更したりする際に利用できます。適切に使用することで、より柔軟で動的なウェブアプリケーションを開発することが可能になります。

構文(syntax)


1<?php
2
3$dom = new DOMDocument();
4$dom->loadHTML('<html><body><div id="old">Old Content</div></body></html>');
5
6$oldNode = $dom->getElementById('old');
7$newNode = $dom->createElement('div', 'New Content');
8
9$parentNode = $oldNode->parentNode;
10$parentNode->replaceChild($newNode, $oldNode);
11
12echo $dom->saveHTML();
13
14?>

引数(parameters)

Dom\Node $newChild, Dom\Node $oldChild

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

戻り値(return)

Dom\Node

replaceChildメソッドは、指定した子ノードを新しい子ノードに置き換えた場合、置き換えられた古い子ノードを返します。

サンプルコード

PHP: DomDocument replaceChildで要素を置き換える


1<?php
2
3/**
4 * Dom\Element::replaceChild を使用して、特定の子要素を新しい要素に置き換えるサンプル関数
5 */
6function replaceDomElementExample(): void
7{
8    // 操作対象となるHTML文字列を定義
9    $htmlString = <<<HTML
10    <!DOCTYPE html>
11    <html>
12    <body>
13        <h1>アイテムリスト</h1>
14        <ul id="item-list">
15            <li>アイテム1</li>
16            <li id="target-item">古いアイテム2 (これだけ置き換える)</li>
17            <li>アイテム3</li>
18        </ul>
19    </body>
20    </html>
21    HTML;
22
23    // 1. DOMDocumentオブジェクトを生成し、HTMLを読み込む
24    $dom = new DOMDocument();
25    // HTML5のタグを正しく解釈するためにエラー出力を抑制
26    libxml_use_internal_errors(true);
27    $dom->loadHTML($htmlString, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
28    libxml_clear_errors();
29
30    // 2. 親要素 (ul#item-list) を取得
31    // DOMElementオブジェクトが返される
32    $parentElement = $dom->getElementById('item-list');
33
34    // 3. 置き換えられる古い子要素 (li#target-item) を取得
35    // DOMElementオブジェクトが返される
36    $oldChild = $dom->getElementById('target-item');
37
38    // 4. 置き換えるための新しい子要素 (li) を作成
39    $newChild = $dom->createElement('li', '新しいアイテム2');
40    $newChild->setAttribute('class', 'updated'); // 新しい要素に属性を追加
41
42    // 5. 親要素のreplaceChildメソッドを実行し、要素を置き換える
43    // $parentElementの子である$oldChildを$newChildで置き換える
44    // 戻り値として、取り除かれた古いノード($oldChild)が返される
45    if ($parentElement && $oldChild) {
46        $parentElement->replaceChild($newChild, $oldChild);
47    }
48
49    // 6. 変更後のHTMLを出力して確認
50    echo $dom->saveHTML();
51}
52
53// 関数を実行
54replaceDomElementExample();
55
56?>

このPHPサンプルコードは、DOM拡張機能を利用して、HTML文書内にある特定の子要素を新しく作成した要素に置き換える処理を実演しています。この操作の中心となるのが Dom\Element クラスの replaceChild メソッドです。

コードの処理は、まず DOMDocument オブジェクトを生成し、操作対象のHTML文字列を読み込むところから始まります。次に getElementById を使い、親要素である <ul> タグと、置き換え対象となる古い <li> タグをそれぞれ取得します。続いて createElement を用いて、これらと置き換えるための新しい <li> 要素を作成しています。

replaceChild メソッドは、親要素のオブジェクトから呼び出します。第1引数には新しく挿入するノード（$newChild）を、第2引数には置き換えたい既存の子ノード（$oldChild）を渡します。このメソッドが実行されると、$oldChild がDOMツリーから削除され、その位置に $newChild が挿入されます。メソッドの戻り値として、取り除かれた古いノード（この例では$oldChild）が返されます。

最後に saveHTML メソッドで変更が反映されたHTMLを出力し、要素が正しく置き換えられたことを確認できます。

Dom\Element::replaceChildメソッドは、子要素を置き換えたい親要素から呼び出す必要があります。引数には、まず新しい要素を、次に置き換えられる古い要素の順で指定しますので、順番を間違えないように注意してください。特に、親要素や古い子要素がgetElementByIdなどで正しく取得できなかった場合、nullが返されます。そのままreplaceChildを呼び出すとエラーが発生するため、サンプルコードのようにif文で要素の存在を必ず確認してから実行することが重要です。また、HTMLを読み込む際には、HTML5のタグを安定して処理するため、libxml_use_internal_errors(true)とLIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTDフラグの利用が有効ですが、使用後はlibxml_clear_errors()でエラー状態をクリアするように心がけてください。

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


1<?php
2
3// Dom\Element::replaceChild メソッドのサンプルコード
4// このコードは、DOMツリー内の既存の子ノードを、新しい子ノードで置き換える方法を示します。
5
6// 1. 新しい Dom\Document オブジェクトを作成します。
7//    これは、HTMLやXMLドキュメントを表すオブジェクトで、DOM操作の基盤となります。
8$document = new Dom\Document();
9
10// 2. ドキュメントのルートとなる要素（例: <body>）を作成し、ドキュメントに追加します。
11//    この要素が、子ノードを持つ親要素になります。
12$bodyElement = $document->createElement('body');
13$document->appendChild($bodyElement);
14
15// 3. 置き換えの対象となる既存の子ノードを作成し、親要素に追加します。
16//    ここでは、最初の <p> タグが後で置き換えられるノードになります。
17$oldParagraph = $document->createElement('p', 'これは置き換えられる段落です。');
18$bodyElement->appendChild($oldParagraph);
19
20// 4. 置き換えの対象ではない別の子ノードも追加します。
21//    これにより、置き換え操作がどこに影響するかを明確にします。
22$anotherParagraph = $document->createElement('p', 'これは置き換えられない段落です。');
23$bodyElement->appendChild($anotherParagraph);
24
25// 5. 既存のノードと置き換えるための新しい子ノードを作成します。
26//    ここでは、新しい <span> タグを作成します。
27$newSpan = $document->createElement('span', '新しいスパン要素です！');
28
29echo "--- 置き換え前のHTML構造 ---\n";
30// `saveHTML()` メソッドで現在のDOMツリーをHTML文字列として出力します。
31echo $document->saveHTML();
32echo "\n";
33
34// 6. Dom\Element::replaceChild メソッドを使ってノードを置き換えます。
35//    `$bodyElement` の子である `$oldParagraph` を `$newSpan` で置き換えます。
36//    このメソッドは、置き換えられた（削除された）ノード（この場合は `$oldParagraph`）を返します。
37$replacedNode = $bodyElement->replaceChild($newSpan, $oldParagraph);
38
39echo "--- 置き換え後のHTML構造 ---\n";
40echo $document->saveHTML();
41echo "\n";
42
43// 置き換えられたノードの内容を確認できます。
44echo "置き換えられたノード（元の子ノード）の内容: " . $replacedNode->textContent . "\n";
45
46// この出力から、`"これは置き換えられる段落です。"` というテキストが `"<p>"` タグごと削除され、
47// その位置に `"<span class="新しいスパン要素です！">"` が挿入されたことがわかります。
48
49?>

PHPのDom\Element::replaceChildメソッドは、DOMツリー内で、指定された親要素の子ノードを新しい子ノードで置き換える際に使用される重要なメソッドです。このメソッドを呼び出すことで、親要素に属する特定の子ノードの位置を保ちつつ、その内容を新しいノードに更新できます。

サンプルコードでは、まずDom\Documentオブジェクトを作成し、DOM操作の基盤を準備しています。次に、body要素を親としてドキュメントに追加し、置き換えの対象となる「これは置き換えられる段落です。」というテキストを持つ<p>タグ（$oldParagraph）と、置き換えるための「新しいスパン要素です！」というテキストを持つ<span>タグ（$newSpan）を作成しています。

$bodyElement->replaceChild($newSpan, $oldParagraph); の呼び出しにより、$bodyElementの子である$oldParagraphが$newSpanに置き換えられます。このとき、第一引数$newChildには新しく挿入するノード（$newSpan）を、第二引数$oldChildには置き換えの対象となる既存のノード（$oldParagraph）を指定します。このメソッドは、DOMツリーから削除された古いノード（この場合は$oldParagraph）を戻り値として返します。これにより、置き換えられたノードがどのような内容であったかを後で確認できます。

この操作により、元の「これは置き換えられる段落です。」というテキストを持つ<p>タグは削除され、その位置に「新しいスパン要素です！」というテキストを持つ<span>タグが挿入され、DOM構造が更新されます。

Dom\Element::replaceChildメソッドは、指定した親要素内の既存の子ノードを新しいノードで置き換えます。第一引数に新しい子ノード（$newChild）、第二引数に置き換える古い子ノード（$oldChild）を指定する順序を間違えないよう注意が必要です。また、$oldChildは必ずreplaceChildを呼び出す親要素の直接の子でなければなりません。そうでなければエラーが発生します。$newChildが既にDOMツリーの他の場所にある場合、このメソッドが呼び出されるとその元の場所から自動的に削除され、新しい位置に移動します。メソッドの戻り値は、DOMツリーから削除された$oldChildそのものです。これはメモリ上には残りますが、DOMツリーからは切り離されていますので、その後の処理で誤って利用しないよう留意してください。