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

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

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

基本的な使い方

removeChildメソッドは、指定された子ノードを親ノードから削除するメソッドです。このメソッドは、PHPのDOM拡張機能におけるDom\Documentクラスに所属しており、HTMLやXMLドキュメントの構造（DOMツリー）をプログラムから操作する際に利用されます。

具体的には、Dom\Documentのインスタンス、またはその子要素にあたるDom\Elementなどのノードオブジェクトから呼び出すことができます。引数として、親ノードから削除したい子ノードのオブジェクトを指定します。例えば、Webページ上の特定のHTML要素（親ノード）から、その中に含まれる特定の子要素（子ノード）を取り除きたい場合などに、このremoveChildメソッドが活用されます。

メソッドが正常に実行されると、削除された子ノードオブジェクト自身が戻り値として返されます。もし指定されたノードが呼び出し元の親ノードの子ノードではない場合、またはその他の理由で削除が不可能な場合には、エラーが発生する可能性がありますので注意が必要です。このメソッドを使用することで、Webページのコンテンツを動的に生成したり変更したりする際に、DOMツリーの構造を柔軟に制御することができます。

構文(syntax)


1<?php
2
3$domDocumentInstance = new Dom\Document();
4$domNodeToRemove = $domDocumentInstance->createElement('example');
5
6$removedDomNode = $domDocumentInstance->removeChild($domNodeToRemove);
7
8?>

引数(parameters)

Dom\Node $child

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

戻り値(return)

Dom\Node

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

サンプルコード

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


1<?php
2
3// DomDocument と DomNode を使用して、XML ドキュメントから子ノードを削除する例
4
5// DomDocument オブジェクトを作成
6$dom = new DomDocument();
7
8// XML 文字列をロード
9$dom->loadXML('<root><child1>Value 1</child1><child2>Value 2</child2></root>');
10
11// 削除する子ノードを取得
12$root = $dom->documentElement;
13$childToRemove = $root->firstChild; // child1 が削除対象
14
15// 子ノードを削除
16if ($childToRemove !== null) {
17    $removedChild = $root->removeChild($childToRemove);
18
19    // 削除されたノードの情報を表示 (オプション)
20    echo "削除されたノードの名前: " . $removedChild->nodeName . "\n";
21}
22
23// 変更後の XML ドキュメントを表示
24echo $dom->saveXML();
25
26?>

このサンプルコードは、PHPのDomDocumentクラスとDomNodeクラスを使用して、XMLドキュメントから子ノードを削除する方法を示しています。

まず、DomDocumentオブジェクトを作成し、loadXML()メソッドを使ってXML文字列を読み込みます。次に、削除したい子ノードを特定します。この例では、ルート要素の最初の子ノード（<child1>）を削除対象としています。firstChildプロパティを使って最初の子ノードを取得しています。

removeChild()メソッドは、指定された子ノードを親ノードから削除する役割を持ちます。引数には削除するDom\Nodeオブジェクトである$childを指定します。このメソッドは、削除されたノードであるDom\Nodeオブジェクトを返します。削除が成功すると、$removedChildには削除されたノードの情報が格納されます。削除されたノードの名前をnodeNameプロパティで取得し、表示しています。

最後に、saveXML()メソッドを使って変更後のXMLドキュメントを文字列として出力します。これにより、子ノードが削除されたXML構造を確認できます。サンプルコードでは、削除対象の子ノードが存在するかどうかをif ($childToRemove !== null)で確認することで、予期せぬエラーを防いでいます。removeChild()メソッドを使用することで、XMLドキュメントの構造をプログラムから動的に変更することが可能です。

removeChildメソッドは、指定された子ノードを親ノードから削除します。削除する子ノードが実際に親ノードの子であるか確認が必要です。firstChildを使用する場合、要素によってはテキストノード（空白など）が最初の子ノードになる可能性があるため注意してください。削除対象のノードが存在しない場合（$childToRemoveがnullの場合など）、removeChildを呼び出すとエラーになる可能性があります。サンプルコードのように、削除前にnullチェックを行うことを推奨します。また、削除されたノードはメモリ上に残りますが、ドキュメントツリーからは切り離されます。