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

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

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

基本的な使い方

removeChildメソッドは、子ノードのリストから指定した子ノードを削除する処理を実行するメソッドです。このメソッドは親クラスである Dom\Node から継承されていますが、Dom\EntityReference クラスのコンテキストでは特別な動作をします。Dom\EntityReference オブジェクトは、XMLドキュメント内のエンティティ参照を表すものであり、その仕様上、子ノードを持つことが許可されていません。そのため、このノードに対して子を追加したり削除したりするような変更操作は行えません。もし Dom\EntityReference オブジェクトに対して removeChild メソッドを呼び出した場合、引数でどのノードを指定しても、常に DOMException という例外がスローされます。これは、ノードの種類が変更操作をサポートしていないことを示すエラーです。ドキュメントの構造からノードを削除したい場合は、Dom\Element のような、子ノードを持つことができ、変更が可能な別の種類のノードに対してこのメソッドを使用する必要があります。したがって、Dom\EntityReference における removeChild メソッドは、継承によって存在するものの、事実上、このクラスの不変性を保証する役割を果たしています。

構文(syntax)


1$removed_node = $entity_reference_object->removeChild($child_node);

引数(parameters)

Dom\Node $child

Dom\Node $child: 削除する子ノードを指定するDom\Nodeオブジェクト

戻り値(return)

Dom\Node

removeChildメソッドは、指定した子ノードを削除した後の、親ノード自身を返します。

サンプルコード

PHP DOM removeChildで要素を削除する


1<?php
2
3/**
4 * DOM要素から指定した子要素を削除するサンプルコード
5 */
6function removeDomNodeExample(): void
7{
8    // 操作対象のHTML文字列
9    $html = <<<HTML
10    <!DOCTYPE html>
11    <html lang="ja">
12    <head>
13        <meta charset="UTF-8">
14        <title>DOM removeChild Example</title>
15    </head>
16    <body>
17        <h1>アイテムリスト</h1>
18        <ul id="item-list">
19            <li id="item1">アイテム1</li>
20            <li id="item2">アイテム2 (これを削除します)</li>
21            <li id="item3">アイテム3</li>
22        </ul>
23    </body>
24    </html>
25    HTML;
26
27    // DOMDocumentオブジェクトを作成
28    $dom = new DOMDocument();
29
30    // HTMLを読み込む (エラーを抑制し、内部で処理)
31    // HTML5の要素に対応するため、libxmlのエラーは抑制します
32    libxml_use_internal_errors(true);
33    $dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
34    libxml_clear_errors();
35
36    // 親要素 (ul#item-list) を取得
37    $parentElement = $dom->getElementById('item-list');
38
39    // 削除対象の子要素 (li#item2) を取得
40    $childToRemove = $dom->getElementById('item2');
41
42    // 親要素と子要素が正しく取得できたか確認
43    if ($parentElement && $childToRemove) {
44        // 削除前のHTMLを出力
45        echo "--- 削除前 ---\n";
46        echo $dom->saveHTML();
47        echo "\n";
48
49        // 親要素から子要素を削除
50        // removeChildは削除したノードを返す
51        $removedNode = $parentElement->removeChild($childToRemove);
52
53        // 削除後のHTMLを出力
54        echo "--- 削除後 ---\n";
55        echo $dom->saveHTML();
56        echo "\n";
57        
58        // 削除されたノードの情報を確認
59        echo "--- 削除されたノード ---\n";
60        // saveHTML() は DOMNode オブジェクトにも適用可能
61        echo $dom->saveHTML($removedNode);
62    } else {
63        echo "指定された要素が見つかりませんでした。";
64    }
65}
66
67// 関数の実行
68// CLIでもブラウザでも見やすいようにヘッダーを設定
69header('Content-Type: text/plain; charset=utf-8');
70removeDomNodeExample();

PHPのremoveChildメソッドは、DOM（Document Object Model）ツリー構造において、特定の親要素から指定した子要素を削除するために使用します。

このサンプルコードでは、まずDOMDocumentオブジェクトを生成し、操作対象となるHTML文字列を読み込んでいます。次に、getElementByIdメソッドを利用して、親要素である<ul>タグ（ID: item-list）と、その中から削除したい子要素である<li>タグ（ID: item2）をそれぞれ取得します。

削除処理の核心部分は $parentElement->removeChild($childToRemove) の箇所です。これは、$parentElementが持つ子要素の中から、引数で指定された$childToRemoveに一致する要素を取り除く命令です。

このメソッドの引数には、削除したい子要素のDom\Nodeオブジェクトを渡します。処理が成功すると、戻り値として削除された子要素のDom\Nodeオブジェクトが返されます。サンプルコードでは、この戻り値を$removedNode変数に代入し、削除が確実に行われたことと、削除された要素の内容を後から確認しています。このようにremoveChildは、プログラムで動的にHTMLの構造を変更する際に役立ちます。

removeChildメソッドを使用する際は、呼び出し元のノードが削除対象ノードの直接の親であることを確認する必要があります。親ではないノードから子ノードを削除しようとするとエラーが発生します。また、getElementByIdなどで要素を取得する際、対象が存在しない場合はnullが返されます。そのため、サンプルコードのように、削除処理の前に親要素と子要素が両方とも存在するかを必ずチェックすることが安全なコードを書く上で重要です。このメソッドは削除したノードを返り値として返すため、そのノードを変数に保持しておけば、後でドキュメントの別の場所に追加するなどの再利用も可能です。