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

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

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

基本的な使い方

replaceChildメソッドは、DOM (Document Object Model) の Dom\HTMLElement クラスに属するメソッドで、ある子ノードを別の新しいノードで置き換えるために使用します。具体的には、指定された要素の子ノードリストにおいて、既存の子ノードを新しいノードで置き換える操作を行います。

このメソッドは、置き換える対象となる既存の子ノードと、新たに挿入するノードの2つの引数を必要とします。メソッドを実行すると、既存の子ノードはDOMツリーから削除され、代わりに新しいノードが元の位置に挿入されます。

replaceChildメソッドの主な役割は、DOM構造を動的に変更することです。例えば、ウェブページの内容をJavaScriptなどのスクリプトから操作する際に、特定の要素の内容を別の要素に置き換えたり、要素の属性を変更したりする際に利用されます。

このメソッドは、DOMツリーの構造を直接操作するため、使用する際には注意が必要です。誤った使い方をすると、意図しない結果を引き起こしたり、ウェブページの表示が崩れたりする可能性があります。特に、置き換えるノードや挿入するノードの型が適切でない場合、エラーが発生することがあります。

replaceChildメソッドを使用する際には、事前に置き換えるノードと挿入するノードが適切な型であるかを確認し、DOMツリーの構造を十分に理解した上で操作を行うことが重要です。また、変更後のDOM構造が期待通りになっているかを検証することも推奨されます。

構文(syntax)


1public Dom\Node replaceChild(Dom\Node $newChild, Dom\Node $oldChild): Dom\Node|false

引数(parameters)

Dom\Node $newChild, Dom\Node $oldChild

Dom\Node $newChild: 新しく挿入するノード。
Dom\Node $oldChild: 置き換える既存のノード。

戻り値(return)

Dom\Node

replaceChild メソッドは、指定された子ノードを、新しい子ノードで置き換えた結果として、置き換えられた元の古い子ノードを返します。

サンプルコード

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


1<?php
2
3// Dom\HTMLElement::replaceChild メソッドの使用例
4// このメソッドは、指定された親要素の子ノードを、新しいノードで置き換えます。
5
6// 1. HTMLドキュメントオブジェクトを作成し、操作するHTMLコンテンツをロードします。
7$document = new Dom\HTMLDocument();
8$htmlContent = '
9    <div id="main-container">
10        <h1>DOM操作の例</h1>
11        <ul id="my-list">
12            <li id="first-item">最初のアイテム（置き換え対象）</li>
13            <li>二番目のアイテム</li>
14            <li>三番目のアイテム</li>
15        </ul>
16        <p>上記はリストです。</p>
17    </div>';
18$document->loadHTML($htmlContent);
19
20echo "--- 変更前のHTML ---\n";
21echo $document->saveHTML();
22echo "\n";
23
24// 2. 置き換え対象となる親要素と、置き換えられる子ノードを取得します。
25// replaceChild メソッドは親ノードのメソッドとして呼び出されるため、親要素が必要です。
26// getElementById は Dom\HTMLElement のインスタンスを返します。
27$parentList = $document->getElementById('my-list'); // 親要素 (<ul>)
28$oldChild = $document->getElementById('first-item'); // 置き換えられる子ノード (<li>)
29
30// 3. 新しい子ノードを作成します。
31$newChild = $document->createElement('li', '新しく追加されたアイテム！');
32$newChild->setAttribute('id', 'new-item');
33
34// 4. Dom\HTMLElement::replaceChild メソッドを呼び出して子ノードを置き換えます。
35// 最初の引数に新しいノード、二番目の引数に置き換えられる古いノードを渡します。
36// このメソッドは、置き換えられた古いノードを返します。
37$replacedNode = $parentList->replaceChild($newChild, $oldChild);
38
39echo "--- 変更後のHTML ---\n";
40echo $document->saveHTML();
41echo "\n";
42
43// 置き換えられた古いノードも、まだ存在し、情報を参照できます。
44echo "置き換えられた古いノードのID: " . $replacedNode->getAttribute('id') . "\n";
45echo "新しいノードのID: " . $newChild->getAttribute('id') . "\n";
46
47?>

Dom\HTMLElement::replaceChildメソッドは、HTMLドキュメントツリーにおいて、特定の親要素が持つ子ノードを、別の新しいノードと置き換える際に利用されます。このサンプルコードでは、まずDom\HTMLDocumentオブジェクトを作成し、操作対象となるHTMLコンテンツを読み込みます。次に、IDを用いて置き換えの親となる要素、例えば<ul>タグと、置き換えられる対象の子ノード、例えば<li>タグを取得します。replaceChildメソッドは親要素のメソッドとして呼び出されるため、親要素の特定が重要です。その後、createElementメソッドを使って新しい<li>タグを作成し、置き換える準備をします。実際にreplaceChildを呼び出す際には、第一引数に「新しく追加したいノード（$newChild）」を、第二引数に「現在存在し、置き換えられる古いノード（$oldChild）」を指定します。このメソッドは、ドキュメントから削除された「置き換えられた古いノード」を戻り値として返します。これにより、置き換え後も古いノードの情報を参照したり、再利用したりすることが可能です。コードの最後では、変更前後のHTMLや、置き換えられたノードの情報を確認することで、操作が正常に行われたことを示しています。

Dom\HTMLElement::replaceChildメソッドは、子ノードを置き換える対象となる親要素のメソッドとして呼び出します。引数の順序は、新しく追加するノードが第一引数、置き換えられる古いノードが第二引数です。置き換えられる古いノードは、必ず呼び出し元の親要素の直接の子である必要があります。もし存在しない子ノードを指定した場合、エラーが発生する可能性がありますので注意が必要です。このメソッドは、DOMツリーから削除された古いノードを戻り値として返します。これにより、削除後もそのノードの情報を参照できます。新しいノードは、replaceChildを呼び出す前にcreateElementなどで適切に作成しておく必要があります。

PHP DOM replaceChildで要素を置き換える


1<?php
2
3/**
4 * Dom\HTMLElement::replaceChild メソッドのサンプルコード
5 *
6 * この関数は、HTMLドキュメント内で特定の子ノードを新しいノードで置き換える方法を示します。
7 * システムエンジニアを目指す初心者の方にも理解しやすいように、DOM操作の基本的な流れに沿っています。
8 */
9function demonstrateReplaceChild(): void
10{
11    // 1. 新しいHTMLドキュメントを作成します。
12    // Dom\HTMLDocument は、HTML構造を持つDOMツリーを構築するためのクラスです。
13    // PHP 8 から利用可能な Dom 名前空間のクラスを使用しています。
14    $document = new Dom\HTMLDocument();
15
16    // ドキュメントの<body>要素を取得します。
17    // Dom\HTMLDocument は、デフォルトで <html>, <head>, <body> を持っています。
18    // $document->body は Dom\HTMLElement のインスタンスを返します。
19    $body = $document->body;
20    echo "--- 初期状態のHTML ---\n";
21    echo $document->saveHTML(); // 現在のHTMLを出力して確認
22    echo "\n";
23
24    // 2. 置き換え対象となる既存の子ノードを作成し、<body>に追加します。
25    // createElement メソッドで新しい要素ノードを作成します。
26    $oldChild = $document->createElement('p');
27    $oldChild->textContent = 'これは古い段落です。置き換えられる予定です。';
28    $body->appendChild($oldChild); // <body>の子として追加します。
29
30    // 別の段落も追加しておき、置き換え対象でないことを示します。
31    $anotherChild = $document->createElement('p');
32    $anotherChild->textContent = 'これは別の段落です。これは残ります。';
33    $body->appendChild($anotherChild);
34
35    echo "--- 子ノード追加後のHTML ---\n";
36    echo $document->saveHTML();
37    echo "\n";
38
39    // 3. 置き換えるための新しい子ノードを作成します。
40    $newChild = $document->createElement('span');
41    $newChild->textContent = 'これは新しいスパン要素です！古いのと交換されます。';
42    $newChild->setAttribute('style', 'color: blue; font-weight: bold;');
43
44    // 4. Dom\HTMLElement::replaceChild メソッドを呼び出して子ノードを置き換えます。
45    // replaceChild(Dom\Node $newChild, Dom\Node $oldChild)
46    // - $newChild: 挿入する新しいノード
47    // - $oldChild: 置き換えられる既存のノード
48    // 戻り値は、置き換えられた (DOMツリーから削除された) $oldChild です。
49    $replacedNode = $body->replaceChild($newChild, $oldChild);
50
51    echo "--- replaceChild 実行後のHTML ---\n";
52    echo $document->saveHTML();
53    echo "\n";
54
55    // 5. 戻り値の確認と、操作の結果を説明します。
56    echo "置き換えられたノードのテキストコンテンツ: " . $replacedNode->textContent . "\n";
57    echo "これで、'古い段落' は '新しいスパン要素' に置き換わりました。\n";
58}
59
60// 関数の実行
61demonstrateReplaceChild();
62

PHP 8のDom\HTMLElement::replaceChildメソッドは、HTMLドキュメント内で、ある特定の子ノードを別の新しいノードで置き換えるために使用されます。このメソッドは、指定されたDom\Node型の新しい子ノード（$newChild）を、同じくDom\Node型の既存の子ノード（$oldChild）の位置に挿入し、$oldChildをDOMツリーから削除します。戻り値として、DOMツリーから削除された$oldChildが返されます。

サンプルコードでは、まず新しいHTMLドキュメントを作成し、その<body>要素に「古い段落」を表す<p>要素を追加しています。次に、この「古い段落」を置き換えるための「新しいスパン要素」を表す<span>要素を作成します。そして、$document->body->replaceChild($newChild, $oldChild)を呼び出すことで、「古い段落」は「新しいスパン要素」に置き換えられ、HTMLドキュメントの内容が更新されます。この操作により、WebページのDOM構造を動的に変更することが可能です。

replaceChildメソッドは、親要素の子ノードを、新しいノードと置き換える際に利用します。引数は、新しく挿入するノードが第一引数、置き換えられる既存のノードが第二引数であることに特に注意してください。置き換え対象となる古いノードは、必ずメソッドを呼び出す親要素の直接の子ノードでなければなりません。もし存在しないノードや、他の親要素の子ノードを指定した場合、実行時エラーとなる可能性がありますので、必ず事前に確認することが重要です。このメソッドは、DOMツリーから削除された古いノードそのものを戻り値として返します。そのため、削除されたノードの内容を確認したり、必要に応じて別の場所で再利用したりすることが可能です。サンプルコードではPHP 8で導入された新しいDom名前空間のクラスを使用しており、より現代的なDOM操作の学習に役立ちます。