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

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

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

基本的な使い方

removeChildメソッドは、DOM（Document Object Model）におけるノードの削除を実行するメソッドです。具体的には、Dom\HTMLElementクラスに属するメソッドとして、指定された子ノードを、その親ノードから削除します。このメソッドを使用することで、動的にHTMLやXMLドキュメントの構造を操作し、不要になった要素を削除することができます。removeChildメソッドは、引数として削除したい子ノードを受け取ります。削除が成功すると、削除されたノードが返されます。もし指定されたノードが子ノードでなかった場合、または親ノードが存在しない場合は、例外が発生します。

このメソッドは、ウェブページのコンテンツを動的に変更する際に非常に役立ちます。例えば、ユーザーの操作に応じて特定の要素を削除したり、条件に基づいてコンテンツを切り替えたりする際に利用できます。removeChildメソッドを使用する際には、削除対象のノードが実際に親ノードの子ノードであるかどうかを確認することが重要です。誤ったノードを指定すると、予期しないエラーが発生する可能性があります。

removeChildメソッドは、DOM操作における基本的な機能の一つであり、ウェブ開発者にとって不可欠なメソッドと言えるでしょう。DOM構造を理解し、適切にremoveChildメソッドを使用することで、柔軟で動的なウェブアプリケーションを構築することが可能になります。removeChildメソッドは、PHPのDOM拡張機能の一部として提供され、他のDOM操作メソッドと組み合わせて使用することで、より複雑なドキュメント操作を実現できます。

構文(syntax)


1Dom\HTMLElement::removeChild(Dom\Node $oldChild): Dom\Node|false

引数(parameters)

Dom\Node $child

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

戻り値(return)

Dom\Node

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

サンプルコード

PHP DOM removeChild で要素を削除する


1<?php
2
3/**
4 * Dom\HTMLElement::removeChild の使用例を示す関数です。
5 *
6 * 指定した親要素から子要素を削除する方法を実演します。
7 */
8function demonstrateRemoveChild(): void
9{
10    // 操作の対象となるHTML文字列を定義します。
11    $html = <<<HTML
12    <!DOCTYPE html>
13    <html lang="ja">
14    <head>
15        <meta charset="UTF-8">
16        <title>DOM removeChild Example</title>
17    </head>
18    <body>
19        <h1>果物リスト</h1>
20        <ul id="fruit-list">
21            <li id="item-apple">りんご</li>
22            <li id="item-banana">バナナ</li>
23            <li id="item-orange">オレンジ</li>
24        </ul>
25    </body>
26    </html>
27    HTML;
28
29    // DOMDocumentオブジェクトを生成し、HTMLを読み込みます。
30    $dom = new DOMDocument();
31    // HTMLのパースエラーを抑制するために@を付けています。
32    // また、文字化けを防ぐため、HTML5の推奨される方法でエンコーディングを指定します。
33    @$dom->loadHTML('<?xml encoding="utf-8" ?>' . $html);
34
35    // 要素の検索を容易にするため、DOMXPathオブジェクトを生成します。
36    $xpath = new DOMXPath($dom);
37
38    // 親要素である<ul> (id="fruit-list") を取得します。
39    // ->item(0) は、見つかったノードリストの最初の要素を取得することを意味します。
40    /** @var Dom\HTMLElement|null $listElement */
41    $listElement = $xpath->query('//ul[@id="fruit-list"]')->item(0);
42
43    // 削除対象の子要素である<li> (id="item-banana") を取得します。
44    /** @var Dom\Node|null $itemToRemove */
45    $itemToRemove = $xpath->query('//li[@id="item-banana"]')->item(0);
46
47    // 親要素と削除対象の子要素の両方が見つかった場合のみ処理を実行します。
48    if ($listElement instanceof Dom\HTMLElement && $itemToRemove instanceof Dom\Node) {
49        echo "--- 削除前のリスト ---" . PHP_EOL;
50        // saveHTMLにノードを渡すと、そのノードのHTMLのみを出力します。
51        echo $dom->saveHTML($listElement) . PHP_EOL;
52
53        // 親要素($listElement)から子要素($itemToRemove)を削除します。
54        // removeChildメソッドは、削除に成功した場合、削除されたノード自身を返します。
55        $removedNode = $listElement->removeChild($itemToRemove);
56
57        echo "--- 削除されたノード ---" . PHP_EOL;
58        echo "テキスト: " . $removedNode->textContent . PHP_EOL . PHP_EOL;
59
60        echo "--- 削除後のリスト ---" . PHP_EOL;
61        echo $dom->saveHTML($listElement) . PHP_EOL;
62    } else {
63        echo "要素が見つかりませんでした。" . PHP_EOL;
64    }
65}
66
67// 関数を実行します。
68demonstrateRemoveChild();

このサンプルコードは、PHPのDom\HTMLElement::removeChildメソッドの使い方を示しています。removeChildメソッドは、指定された親要素から子要素を削除するために使用されます。引数には、削除したいDom\Nodeオブジェクトである $child を渡します。このメソッドは、削除に成功した場合、削除されたDom\Nodeオブジェクトを返します。

まず、HTML文字列をDOMDocumentオブジェクトに読み込み、DOMXPathを使って削除対象の要素とその親要素を取得します。$listElement は親要素である <ul> を、 $itemToRemove は削除する子要素である <li> をそれぞれ表します。

removeChildメソッドを $listElement->removeChild($itemToRemove) のように呼び出すことで、<ul>要素から<li>要素が削除されます。サンプルコードでは、削除前後のHTMLを表示し、さらに削除されたノードのテキストコンテンツを表示することで、removeChildの効果を確認できます。要素が見つからない場合は、エラーメッセージが表示されます。このメソッドを使うことで、DOM構造を動的に変更できます。

removeChildメソッドは、指定した子ノードを親ノードから削除する際に使用します。削除対象のノードが親ノードの直接の子である必要があります。ノードが見つからない場合、$listElementや$itemToRemoveがnullになり、エラーが発生する可能性があるため、instanceofで型チェックを行うことが重要です。

loadHTML関数使用時に@マークでエラーを抑制していますが、これは実際のエラーを隠蔽してしまうため、デバッグ時には取り除くことを推奨します。また、文字化け対策として<?xml encoding="utf-8" ?>を付与していますが、HTML5では<meta charset="UTF-8">での指定が推奨されます。saveHTMLにノードを渡すと、ドキュメント全体ではなく、そのノードのHTMLのみが出力される点に注意してください。