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

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

作成日: 2025年09月11日更新日: 2025年12月01日

基本的な使い方

removeメソッドは、Dom\CDATASectionクラスに属し、現在のCDATAセクションノードを親ノードから削除するメソッドです。

PHPのDOM拡張機能は、XMLやHTMLなどのドキュメントをオブジェクトとして扱い、その構造をプログラムから操作するための機能を提供します。Dom\CDATASectionクラスは、XMLドキュメント内でマークアップとして解釈されたくない内容をそのままテキストとして保持するための特殊なセクション、すなわちCDATAセクションを表します。

このremoveメソッドは、Dom\CDATASectionオブジェクトに対して呼び出されると、そのオブジェクトが表すCDATAセクションノードを、それが属するDOMツリーから完全に切り離します。具体的には、CDATAセクションノードの親ノードとの関連を断ち切り、ドキュメントの論理的な構造から該当のCDATAセクションを削除します。

removeメソッドは引数を一切必要とせず、また戻り値もありません。このメソッドを呼び出した後は、当該CDATAセクションはもはやドキュメントの一部ではないため、ドキュメントを保存したり表示したりする際にはその内容は含まれなくなります。したがって、DOMツリーから特定のCDATAセクションを取り除きたい場合に利用される、シンプルかつ直接的な操作を提供します。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$element = $dom->createElement('example');
4$cdataSection = $dom->createCDATASection('Content of CDATA');
5$element->appendChild($cdataSection);
6$dom->appendChild($element);
7
8$cdataSection->remove();
9?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

void

このメソッドは、DOMツリーからCDATAセクションノードを削除します。戻り値はありません。

サンプルコード

CDATAセクションを削除する


1<?php
2
3// Dom\CDATASection の remove メソッドのサンプルコード
4
5// ドキュメントを作成
6$dom = new DOMDocument();
7
8// CDATA セクションを追加
9$cdata = $dom->createCDATASection("This is a CDATA section.");
10
11// 親ノード（例：ルート要素）を作成し、CDATA セクションを追加
12$root = $dom->createElement("root");
13$root->appendChild($cdata);
14$dom->appendChild($root);
15
16// CDATA セクションを削除
17$cdata->remove();
18
19// 結果を出力（CDATA セクションが削除されていることを確認）
20echo $dom->saveXML();
21
22?>

PHP 8 における Dom\CDATASection クラスの remove メソッドは、CDATA セクションをドキュメントから削除するために使用します。このメソッドは引数を取らず、戻り値もありません（void）。つまり、メソッドを呼び出すと、CDATA セクションは所属するノードから削除されます。

サンプルコードでは、まず DOMDocument オブジェクトを作成し、createCDATASection メソッドを使って CDATA セクションを作成しています。次に、ルート要素を作成し、その中に CDATA セクションを追加しています。この時点で、CDATA セクションは XML ドキュメントの一部となります。

$cdata->remove() を呼び出すことで、CDATA セクションがドキュメントから削除されます。remove メソッドは、呼び出された Dom\CDATASection オブジェクト自体を削除するのではなく、そのノードを親ノードから切り離します。

最後に、saveXML メソッドを使ってドキュメントの内容を XML 形式で出力します。remove メソッドが正常に実行されていれば、出力結果には CDATA セクションが含まれていないことが確認できます。このメソッドは、ドキュメントから不要になった CDATA セクションを削除し、XML 構造を動的に変更する際に役立ちます。ファイル操作など、外部リソースに影響を与える処理は行いません。あくまで、DOMオブジェクト内のノード構造を変更するメソッドです。

Dom\CDATASection クラスの remove メソッドは、CDATA セクションをドキュメントから削除します。このメソッドは、CDATA セクションが実際にドキュメントに存在している場合にのみ使用してください。削除対象のノードがドキュメントに存在しない場合、エラーは発生しませんが、何も起こりません。

remove メソッドは、ノードを削除するだけで、メモリから完全に解放するわけではありません。オブジェクトを完全に破棄するには、変数への参照を解除する必要があります。削除後、DOMDocument::saveXML()などでドキュメントを出力する際に、削除されたノードが表示されないことを確認しましょう。