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

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

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

基本的な使い方

removeChildメソッドは、DOMDocumentクラスに所属するメソッドであり、DOMノードツリーから指定された子ノードを削除するために使用されます。具体的には、removeChildメソッドは、あるノード（親ノード）から、指定された子ノードを取り除く操作を行います。

このメソッドは、DOMDocumentオブジェクトが表すXMLドキュメント構造をプログラム的に操作する際に非常に重要です。例えば、XMLドキュメントの特定の要素を削除したり、構造を動的に変更したりする場合にremoveChildメソッドが利用されます。

removeChildメソッドは、削除する子ノードを引数として受け取ります。子ノードは、DOMNodeオブジェクトとして指定する必要があります。メソッドを実行すると、指定された子ノードが親ノードから削除され、ドキュメント構造が更新されます。removeChildメソッドが正常に実行されると、削除された子ノードが返されます。もし、指定されたノードが子ノードでない場合や、エラーが発生した場合は、例外がスローされる可能性があります。

removeChildメソッドを使用する際には、削除するノードが実際に親ノードの子ノードであることを確認することが重要です。また、ノード削除後に他のノードとの関係性が崩れないように、removeChildメソッドの実行結果を考慮して、適切にドキュメント構造を管理する必要があります。removeChildメソッドは、XMLドキュメントの構造を動的に変更するための基本的なツールであり、XML処理を行う上で不可欠なメソッドの一つです。

構文(syntax)


1DOMNode DOMDocument::removeChild( DOMNode $oldNode )

引数(parameters)

DOMNode $child

DOMNode $child: 削除したい子ノードを指定します

戻り値(return)

DOMNode

指定された子ノードを削除した結果、削除されたDOMNodeオブジェクトが返されます。

サンプルコード

PHP DOM removeChildで要素を削除する


1<?php
2
3// DOMDocument を作成します。
4$dom = new DOMDocument();
5
6// ルート要素を作成します。
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// 子要素を2つ作成します。
11$child1 = $dom->createElement('child1');
12$child2 = $dom->createElement('child2');
13
14// 子要素をルート要素に追加します。
15$root->appendChild($child1);
16$root->appendChild($child2);
17
18// child1 を削除します。
19$removedChild = $root->removeChild($child1);
20
21// 削除されたノードを出力します。
22echo $removedChild->nodeName . " was removed.\n";
23
24// ドキュメントを文字列として出力します。
25echo $dom->saveXML();
26
27?>

このPHPのサンプルコードは、DOMDocumentクラスのremoveChildメソッドの使い方を示しています。removeChildメソッドは、指定された子ノードを親ノードから削除する際に使用します。引数には削除したいDOMNodeオブジェクトである$childを指定します。このメソッドは、削除されたDOMNodeオブジェクトを戻り値として返します。

まず、DOMDocumentオブジェクトを作成し、ルート要素となる'root'要素を追加しています。次に、'child1'と'child2'という2つの子要素を作成し、それらをルート要素の子として追加します。

$root->removeChild($child1)という行で、ルート要素から'child1'要素を削除しています。削除されたノードは$removedChild変数に格納され、echo $removedChild->nodeName . " was removed.\n";によって、削除されたノードの名前（この場合は'child1'）が出力されます。

最後に、$dom->saveXML()によって、現在のDOMドキュメントの内容がXML形式の文字列として出力されます。この出力結果を確認することで、'child1'要素が削除されたことを確認できます。removeChildメソッドは、DOMドキュメントから特定の要素を削除する際に非常に役立ちます。

removeChildメソッドは、指定された子ノードを親ノードから削除します。削除対象の子ノード $child は、DOMNode オブジェクトである必要があります。存在しないノードを指定すると、エラーは発生しませんが何も削除されません。このメソッドは削除されたノード自体を返します。サンプルコードでは、削除されたノード名を出力していますが、これは削除が成功したか確認するための手段の一つです。削除後、saveXML()などでドキュメント全体を出力し、意図した通りに削除されているか確認することを推奨します。また、removeChildはノードを削除するだけで、メモリから完全に解放するわけではない点に注意が必要です。大規模なXMLドキュメントを扱う場合は、メモリ管理に注意してください。