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

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

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

基本的な使い方

removeChildメソッドは、指定された子ノードを、その親ノードである現在のDom\DocumentFragmentオブジェクトから削除するメソッドです。

Dom\DocumentFragmentは、ウェブページの構造（DOMツリー）の一部を一時的に格納し、まとめて操作するための軽量なコンテナオブジェクトです。このオブジェクトは、複数のノード（HTML要素など）を一度に生成したり、それらを実際のドキュメントに挿入する前にまとめて加工したりする際に、パフォーマンスの向上に役立ちます。

このremoveChildメソッドを使用すると、Dom\DocumentFragment内にすでに存在する子ノードの中から、特定のノードを選択して削除できます。メソッドの引数には、削除したい子ノード（Dom\Nodeオブジェクト）を指定します。成功すると、削除された子ノードが戻り値として返されます。

削除されたノードは、Dom\DocumentFragmentからは取り除かれますが、メモリ上には引き続き存在するため、必要であれば後で別の位置に再挿入することが可能です。もし指定したノードが、現在のDom\DocumentFragmentの子ノードではない場合、このメソッドはエラー（Dom\DomException）を発生させます。

Dom\DocumentFragment内で複雑なDOM構造を構築している途中で、不要になった要素を取り除いたり、コンテンツの内容を整理したりする際に、このremoveChildメソッドは非常に有効です。これにより、実際のウェブページに反映させる前に、効率的かつ安全にDOM構造を操作できます。

構文(syntax)


1<?php
2$documentFragmentInstance = new Dom\DocumentFragment();
3$childNodeInstance = new Dom\Element('div'); // Dom\Node を継承するクラスのインスタンス
4
5$documentFragmentInstance->removeChild($childNodeInstance);

引数(parameters)

Dom\Node $child

Dom\Node $child: 削除する子ノードを指定します。

戻り値(return)

Dom\Node

削除された子ノードを表す Dom\Node オブジェクトを返します。

サンプルコード

PHP DOM: DocumentFragment の removeChild を使う


1<?php
2
3/**
4 * Dom\DocumentFragment の removeChild メソッドの使用例を示します。
5 *
6 * この関数は、HTMLの断片(DocumentFragment)を作成し、
7 * そこに複数の要素を追加した後、特定の要素を削除する処理を実演します。
8 */
9function demonstrateDomFragmentRemoveChild(): void
10{
11    // PHPのDOM操作でテキストが文字化けしないように、出力のエンコーディングを設定します。
12    header('Content-Type: text/plain; charset=utf-8');
13
14    // 1. DOM操作の土台となるDOMDocumentオブジェクトを作成します。
15    $dom = new DOMDocument();
16
17    // 2. ドキュメントの一部を保持するためのDocumentFragmentを作成します。
18    // DocumentFragmentは、一時的にノードをまとめて扱うための軽量なコンテナです。
19    $fragment = $dom->createDocumentFragment();
20
21    // 3. DocumentFragmentに追加する3つの要素(ノード)を作成します。
22    $p = $dom->createElement('p', 'これは最初の段落です。');
23    $divToRemove = $dom->createElement('div', 'このdiv要素を削除します。');
24    $span = $dom->createElement('span', 'これはspan要素です。');
25
26    // 4. 作成した要素をDocumentFragmentに子ノードとして追加します。
27    $fragment->appendChild($p);
28    $fragment->appendChild($divToRemove);
29    $fragment->appendChild($span);
30
31    // 5.【削除前】のDocumentFragmentの内容を確認します。
32    // ※ DocumentFragment自体は直接出力できないため、一時的な親要素に追加してHTMLとして出力します。
33    echo "--- 削除前のHTML断片 ---\n";
34    echo $dom->saveHTML($fragment) . "\n";
35
36    // 6. removeChild() メソッドを呼び出し、特定の子ノード($divToRemove)を削除します。
37    // このメソッドは、削除したノードを戻り値として返します。
38    $removedNode = $fragment->removeChild($divToRemove);
39
40    // 7. 削除されたノードが何であったかを確認します。
41    echo "--- removeChild() によって削除されたノード ---\n";
42    echo $dom->saveHTML($removedNode) . "\n";
43
44    // 8.【削除後】のDocumentFragmentの内容を確認し、指定したノードが消えていることを確かめます。
45    echo "--- 削除後のHTML断片 ---\n";
46    echo $dom->saveHTML($fragment) . "\n";
47}
48
49// 作成した関数を実行します。
50demonstrateDomFragmentRemoveChild();

このPHPサンプルコードは、Dom\DocumentFragmentオブジェクトから特定の子要素（ノード）を削除するremoveChildメソッドの使い方を示します。最初に、DOM操作の土台となるDOMDocumentと、HTMLの断片を一時的にまとめて扱うための軽量なコンテナであるDocumentFragmentを作成します。次に、段落（p）、div、spanの3つのHTML要素を生成し、appendChildメソッドを使ってこのDocumentFragmentに子要素として追加します。

コードの中心となるremoveChildメソッドは、引数に指定された子ノードをその親から削除する役割を持ちます。このサンプルでは、DocumentFragmentから先ほど追加したdiv要素を削除しています。このメソッドの重要な特徴は、削除したノードそのものを戻り値として返す点です。これにより、削除した要素を変数に保存し、後で内容を確認したり別の場所に移動させたりといった操作が可能になります。

最後に、削除処理の実行前と実行後でDocumentFragmentの内容を出力し、指定したdiv要素が意図通りに取り除かれていることを確認しています。

removeChildメソッドは、引数に削除したいノードのオブジェクトそのものを渡す必要があります。ID名などの文字列ではない点に注意してください。また、削除できるのはメソッドを呼び出したノードの直接の子ノードのみです。親子関係にないノードや孫ノードを指定するとエラーが発生します。このメソッドは削除したノードを戻り値として返すため、削除した要素を別の変数に保持し、後でDOMツリーの他の場所に追加するといった再利用が可能です。実際の開発では、存在しないノードを削除しようとするとプログラムが停止する可能性があるため、対象ノードが存在するかを事前に確認する処理を入れると、より安全なコードになります。