Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

removeメソッドは、PHPのDOM拡張機能において、DOMツリー内のある子ノードが自身の親ノードから自身を削除する操作を実行するメソッドです。このメソッドを呼び出すことで、ドキュメントのDOM(Document Object Model)ツリーから、対象となるノードとそのすべての子孫ノードが効果的に取り除かれます。例えば、ウェブページやXMLドキュメントの内容をプログラムから動的に変更する際に、不要な要素やテキストノードを削除する目的で広く利用されます。

このremoveメソッドは引数を取りません。また、処理が成功した場合でも、特定の値を返すことはなく、戻り値はvoid型となります。このメソッドは、DOMChildNodeインターフェースを実装するあらゆるタイプのノードに適用可能です。これには、DOMElement(要素ノード)、DOMText(テキストノード)、DOMComment(コメントノード)などが含まれます。

重要な点として、ノードが削除されるとDOMツリーからは切り離されますが、そのノードオブジェクト自体はメモリ上からすぐに消滅するわけではありません。もしそのオブジェクトへの参照がコード内に残っていれば、引き続きそのオブジェクトを操作したり、別の場所に再度追加したりすることが可能です。また、もし対象のノードがすでにDOMツリーのどこにも属していない場合(つまり親ノードを持たない場合)にremoveメソッドを呼び出しても、特に何も変更は行われず、エラーも発生しません。この特性により、ドキュメント構造を安全かつ柔軟に操作することが可能になります。

構文(syntax)

1<?php
2
3$doc = new DOMDocument();
4$parent = $doc->createElement('parent');
5$doc->appendChild($parent);
6
7$child = $doc->createElement('child');
8$parent->appendChild($child);
9
10$child->remove();
11
12?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

void

このメソッドは、呼び出し元のノードをその親ノードから削除します。戻り値はありません。

サンプルコード

PHP DOMノードを削除する

1<?php
2
3/**
4 * DOMChildNode::remove() メソッドの使用例を示します。
5 * このメソッドは、DOMツリーから指定されたノードを削除します。
6 * PHP 8では、DOMElementなどのDOMノードがDOMChildNodeインターフェースを実装しています。
7 */
8function exampleDomNodeRemoval(): void
9{
10    // 新しいDOMDocumentインスタンスを作成し、XML宣言を設定
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    // 生成されるXMLを見やすくするために、整形出力を有効にする
13    $dom->formatOutput = true;
14
15    // ルート要素を作成し、ドキュメントに追加
16    $root = $dom->createElement('root');
17    $dom->appendChild($root);
18
19    // いくつかの子要素を作成し、ルート要素に追加
20    $child1 = $dom->createElement('child1', 'これは最初の子要素です');
21    $root->appendChild($child1);
22
23    $child2 = $dom->createElement('child2', 'これは削除される子要素です');
24    $root->appendChild($child2); // 後でこのノードを削除する
25
26    $child3 = $dom->createElement('child3', 'これは最後の子要素です');
27    $root->appendChild($child3);
28
29    echo "--- 削除前のDOMツリー ---\n";
30    // 現在のDOMツリーの内容をXML形式で出力
31    echo $dom->saveXML() . "\n\n";
32
33    // $child2ノードをDOMツリーから削除します。
34    // remove() メソッドは引数を取らず、自身を親ノードから削除します。
35    $child2->remove();
36    echo "child2ノードをDOMツリーから削除しました。\n\n";
37
38    echo "--- 削除後のDOMツリー ---\n";
39    // 削除後のDOMツリーの内容をXML形式で出力
40    echo $dom->saveXML() . "\n";
41}
42
43// サンプル関数を実行
44exampleDomNodeRemoval();

このサンプルコードは、PHPのDOMChildNode::remove()メソッドを使用して、XML構造(DOMツリー)から特定の子ノードを削除する方法を示しています。

PHP 8では、DOMElementなどのDOMノードがDOMChildNodeインターフェースを実装しており、このインターフェースを通じてremove()メソッドが利用できます。remove()メソッドは、そのノード自身を親ノードから取り除きます。

このメソッドには引数がなく、呼び出されたノード自身が対象となります。また、処理が成功しても何も値を返さないvoid型です。

コードではまず、DOMDocumentを作成し、ルート要素とその下に複数の子要素(child1child2child3)を追加してDOMツリーを構築しています。削除前のDOMツリーの内容が一度出力され、その後に$child2->remove();が呼び出されます。これにより、child2ノードがDOMツリーから完全に削除されます。最後に、削除後のDOMツリーが出力され、child2ノードがなくなっていることを確認できます。このメソッドは、XMLやHTMLなどのドキュメント構造をプログラムで操作し、不要な要素を取り除く際に非常に便利です。

このサンプルコードは、XMLやHTMLの構造(DOMツリー)から特定の要素(ノード)を削除するDOMChildNode::remove()メソッドの使用例です。「php remove file」というキーワードがありますが、これはファイルシステム上のファイルを削除する機能とは異なりますので、混同しないよう注意が必要です。remove()メソッドは、そのメソッドが呼び出されたノード自身を、引数なしでDOMツリーから切り離します。このメソッドは何も値を返しません(void)。DOMツリーから削除されたノードは、その構造からはなくなりますが、ノードを指すPHP変数そのものはすぐに解放されるわけではありません。削除対象のノードを間違えないよう、メソッドを呼び出す対象を十分に確認してご利用ください。

関連コンテンツ