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

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

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

基本的な使い方

removeChildメソッドは、通常、親となるDOMノードから、その子ノードとして登録されている特定のノードを削除する際に利用されるメソッドです。このメソッドを実行すると、指定された子ノードは親ノードの子ノードリストから外され、DOMツリーから切り離されます。

しかし、PHPのDom拡張において、Dom\AttrクラスにはremoveChildメソッドは定義されていません。Dom\Attrクラスは、HTMLやXML要素の属性（例えば<div id="myId">のid="myId"部分）を表すためのノードであり、自身が子ノードを持つ構造ではありません。属性ノードは、要素ノードに付随するデータとして扱われるため、子ノードの追加や削除といった操作は行いません。

したがって、もしDOMツリーから子ノードを削除したい場合は、対象となる子ノードの親ノードがDom\ElementやDom\Nodeクラスのインスタンスであることを確認し、その親ノードに対してremoveChildメソッドを使用します。例えば、$parentElement->removeChild($childNode)のように記述します。この機能は、Webページの動的な変更やXMLデータの操作において、要素の構造を調整するための基本的な操作です。

構文(syntax)


1<?php
2
3// $attr は Dom\Attr クラスのインスタンス
4// $childToRemove は削除する Dom\Node クラスのインスタンス
5$attr = new DOMAttr('id');
6$childToRemove = new DOMText('some text');
7
8$removedChild = $attr->removeChild($childToRemove);

引数(parameters)

Dom\Node $child

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

戻り値(return)

Dom\Node

指定された Dom\Attr オブジェクトから子ノードを削除し、削除された Dom\Node オブジェクトを返します。

サンプルコード

PHP DOM Attr removeChildで子ノードを削除する


1<?php
2
3/**
4 * Dom\Attr::removeChild の使用例を実演します。
5 *
6 * この関数は、XML内の特定の属性ノードから、その値を持つ子ノード（テキストノード）を
7 * 削除する方法を示します。
8 */
9function demonstrateAttrRemoveChild(): void
10{
11    // 操作対象となるシンプルなXML文字列
12    $xmlString = <<<XML
13    <?xml version="1.0" encoding="UTF-8"?>
14    <products>
15      <product id="p-101" status="published">商品A</product>
16    </products>
17    XML;
18
19    // DOMDocumentオブジェクトを作成し、XMLを読み込む
20    $dom = new Dom\Document();
21    $dom->loadXML($xmlString);
22
23    // 最初の <product> 要素を取得
24    $productElement = $dom->getElementsByTagName('product')[0];
25
26    // 'status' 属性のノード (Dom\Attr オブジェクト) を取得
27    $statusAttr = $productElement->getAttributeNode('status');
28
29    // --- 変更前の状態を出力 ---
30    echo "--- 変更前 ---" . PHP_EOL;
31    echo "属性 'status' の値: " . $statusAttr->value . PHP_EOL;
32    echo $dom->saveXML() . PHP_EOL;
33
34    // 属性ノードが子ノードを持っているか確認
35    // 属性の値 "published" は、属性ノードの子であるテキストノードとして表現されます
36    if ($statusAttr->hasChildNodes()) {
37        // 削除する子ノード (この場合はテキストノード) を取得
38        $childNodeToRemove = $statusAttr->firstChild;
39
40        // 属性ノードから子ノードを削除
41        $removedNode = $statusAttr->removeChild($childNodeToRemove);
42
43        // --- 変更後の状態を出力 ---
44        echo "--- 変更後 ---" . PHP_EOL;
45        echo "削除されたノードの値: '" . $removedNode->nodeValue . "'" . PHP_EOL;
46        // 子ノードが削除されたため、属性の値は空になります
47        echo "属性 'status' の値: '" . $statusAttr->value . "'" . PHP_EOL;
48        echo $dom->saveXML();
49    }
50}
51
52// 関数を実行して結果を確認
53demonstrateAttrRemoveChild();
54
55?>

このサンプルコードは、PHPのDOM拡張機能におけるDom\AttrクラスのremoveChildメソッドの使い方を示しています。Dom\AttrはXML要素の属性を表すオブジェクトであり、その属性値は実際にはDom\Attrノードの子であるテキストノードとして扱われます。

まず、XML文字列からDom\Documentオブジェクトを作成し、特定の<product>要素からstatus属性のDom\Attrノードを取得します。初期状態では、このstatus属性ノードは"published"というテキストノードを子に持ちます。

removeChildメソッドは、指定された子ノードを親ノードから削除するために使用されます。引数$childには削除したい子ノード（この例ではstatus属性ノードの"published"というテキストノード）を指定します。このメソッドは、削除された子ノード自身を戻り値として返します。

サンプルでは、statusAttr->firstChildで取得したテキストノードをstatusAttr->removeChild()に渡して削除しています。削除が実行されると、status属性ノードからそのテキストノードが失われるため、status属性のvalueは空になります。これにより、XML文書全体で該当する属性の値がなくなります。この機能は、DOMツリー内で属性の値をプログラムから削除したい場合に利用されます。

Dom\Attr::removeChildメソッドは、属性ノードが持つ「値」として表現される子ノード（通常はテキストノード）を削除します。これにより、対象属性の値は空になります。しかし、このメソッドは属性そのものを要素から削除するものではない点に注意が必要です。属性自体を要素から除去したい場合は、Dom\ElementクラスのremoveAttributeなどのメソッドを利用します。引数には、削除したい正確な子ノードを指定する必要があり、存在しない子ノードを削除しようとするとエラーの原因となる可能性があります。そのため、hasChildNodes()などで子ノードの存在を事前に確認してから実行することをお勧めします。また、削除された子ノード自身がこのメソッドの戻り値として返されます。