【PHP8.x】Dom\Node::removeChild()メソッドの使い方
removeChildメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
removeChildメソッドは、指定された子ノードを親ノードから削除するメソッドです。これは、ウェブページやXMLドキュメントの構造（DOMツリー）を動的に変更したい場合に利用されます。
このメソッドはDom\Nodeクラスに属しており、DOMツリー上の親ノードから、その直下にある特定の子ノードを取り除く際に使用します。具体的な使い方としては、親ノードを表すオブジェクトからremoveChildメソッドを呼び出し、削除したい子ノードを表すオブジェクトを引数として渡します。
メソッドが正常に実行されると、指定された子ノードはDOMツリーから切り離され、ウェブページ上からは見えなくなります。しかし、削除されたノードオブジェクト自体はメモリ上に保持され、このメソッドの戻り値として返されます。これにより、削除したノードを後で別の場所に挿入し直したり、完全に破棄したりすることが可能になります。
例えば、特定のHTML要素をページから完全に削除する場合や、要素の表示位置を変更するために一度現在の位置から取り外し、別の場所に再配置する場合などに非常に有効です。ただし、引数として渡すノードは、必ずremoveChildを呼び出す親ノードの直接の子でなければなりません。そうでない場合、エラーが発生しますので注意が必要です。このメソッドは、動的なユーザーインターフェースの構築やコンテンツの管理において、重要な機能を提供します。
構文(syntax)
1<?php 2use Dom\Document; 3use Dom\Element; 4 5$document = new Document(); 6$parentNode = new Element('parent'); 7$childNode = new Element('child'); 8 9$parentNode->appendChild($childNode); 10$document->appendChild($parentNode); 11 12$removedNode = $parentNode->removeChild($childNode); 13?>
引数(parameters)
Dom\Node $child
- Dom\Node $child: 削除したい子ノードを指定します。
戻り値(return)
Dom\Node
指定されたノードが削除された場合、そのノード自体が返されます。
サンプルコード
php dom removeChild で子ノードを削除する
1<?php 2 3// Dom\Node::removeChild のサンプルコード 4 5// HTML ドキュメントを新規作成 6$dom = new DOMDocument(); 7 8// ルート要素を作成 9$root = $dom->createElement('root'); 10$dom->appendChild($root); 11 12// 子要素1を作成 13$child1 = $dom->createElement('child1'); 14$root->appendChild($child1); 15 16// 子要素2を作成 17$child2 = $dom->createElement('child2'); 18$root->appendChild($child2); 19 20// 子要素1を削除 21$removedChild = $root->removeChild($child1); 22 23// 削除されたノードは $removedChild に格納される 24echo "削除されたノードの名前: " . $removedChild->nodeName . PHP_EOL; 25 26// ドキュメントを表示（削除されたノードがないことを確認） 27echo $dom->saveHTML(); 28 29?>
PHPのDOM拡張モジュールにおける、Dom\NodeクラスのremoveChildメソッドは、ノードの削除を行う際に使用します。このメソッドは、指定された子ノードを親ノードから削除し、削除されたノードを返します。
サンプルコードでは、まずDOMDocumentオブジェクトを作成し、ルート要素rootを追加しています。次に、child1とchild2という2つの子要素をroot要素に追加します。
$root->removeChild($child1)の部分が、removeChildメソッドの呼び出しです。この行は、root要素からchild1要素を削除します。削除されたchild1要素は、$removedChild変数に格納されます。
echo "削除されたノードの名前: " . $removedChild->nodeName . PHP_EOL;では、削除されたノードの名前（この場合は"child1"）を表示しています。これは、removeChildメソッドが削除されたノードを返すことを確認するためのものです。
最後に、echo $dom->saveHTML();で、DOMドキュメントをHTMLとして出力しています。出力結果を確認することで、child1要素がroot要素から正常に削除されていることがわかります。removeChildメソッドは、DOMツリーから特定のノードを削除する際に非常に役立ちます。引数には削除したいDom\Nodeオブジェクトを指定し、戻り値として削除されたDom\Nodeオブジェクトが返されます。
Dom\Node::removeChild は、指定された子ノードを親ノードから削除するメソッドです。引数には削除したい子ノードを渡します。削除されたノードは戻り値として返されますが、これは削除されたノードの参照を保持するためであり、必ずしも変数に代入する必要はありません。removeChild 実行後、削除されたノードはドキュメントツリーから切り離されます。削除するノードが親ノードの直接の子でない場合、エラーは発生しませんが、何も削除されません。対象のノードが存在するかどうか事前に確認することを推奨します。saveHTML などで結果を確認する際は、削除されたノードがドキュメントから消えていることを確認してください。