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

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

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

基本的な使い方

replaceWithメソッドは、現在のDOMCdataSectionノードを、指定された新しいDOMノード、または複数のノードのリストで置き換える機能を提供するメソッドです。このメソッドは、XMLドキュメント内の特定のCDATAセクションの場所と内容を、動的に変更する際に非常に役立ちます。

具体的には、DOMCdataSectionオブジェクトに対してこのメソッドを呼び出すと、そのCDATAセクションノード自身はDOMツリーから完全に削除されます。そして、メソッドの引数として渡された新しいDOMノード、またはDOMノードの配列が、削除されたCDATAセクションノードがあった位置に挿入されます。もし引数として与えられたノードが、すでにDOMツリーの別の場所に存在している場合、そのノードは元の位置から移動され、新しい位置に挿入されます。これにより、XMLツリー内のノードを簡単に入れ替えたり、複数のノードで置き換えたりすることが可能です。

この機能は、XMLコンテンツをプログラムで生成、解析、または変換するシステムにおいて、特定のCDATAセクションの内容や位置を効率的に変更する際に利用されます。特にPHP 8以降で導入された機能であり、DOM操作の柔軟性と簡潔性を向上させます。現在のCDATAセクションノードを他のノードで効率的に置き換えたい場合に活用されます。

構文(syntax)


1<?php
2
3$document = new DOMDocument();
4$cdata = $document->createCDATASection('original content');
5
6// DOMCdataSection のインスタンスに対して replaceWith メソッドを呼び出す
7// 引数には、置き換えたいDOMノード（DOMElement, DOMTextなど）や文字列を複数指定できます
8$cdata->replaceWith($document->createTextNode('new text'), 'another string content', $document->createElement('element'));

引数(parameters)

DOMNode|string ...$nodes

DOMNode|string $nodes: 置換する新しいノードまたはノードの配列、あるいはテキストコンテンツを指定する文字列

戻り値(return)

void

このメソッドは、DOMCdataSectionノードを、指定されたノードで置き換えるために使用されます。この操作による直接的な戻り値はありません。

サンプルコード

php dom replaceWithでノードを置換する


1<?php
2
3// ドキュメントを作成
4$dom = new DOMDocument();
5
6// ルート要素を作成
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// CDATAセクションを作成
11$cdata = $dom->createCDATASection('This is CDATA section.');
12$root->appendChild($cdata);
13
14// 新しいテキストノードを作成
15$newText = $dom->createTextNode('Replaced text.');
16
17// CDATAセクションを新しいテキストノードで置換
18$cdata->replaceWith($newText);
19
20// 結果を表示
21echo $dom->saveXML();
22
23?>

PHPのDOMCdataSectionクラスのreplaceWithメソッドは、CDATAセクションノードを、指定されたノードまたは文字列で置き換えるために使用します。このメソッドはPHP 8で導入されました。

このサンプルコードでは、まずDOMDocumentオブジェクトを作成し、ルート要素を追加しています。次に、createCDATASectionメソッドを用いてCDATAセクションを作成し、ルート要素の子ノードとして追加します。

その後、createTextNodeメソッドで新しいテキストノードを作成し、これがCDATAセクションを置き換えるノードとなります。

$cdata->replaceWith($newText);の部分がreplaceWithメソッドの呼び出しです。引数には、置き換えに使用するDOMNodeオブジェクトまたは文字列を渡します。この例では、$newText（テキストノード）を引数に渡しています。複数のノードや文字列を引数として渡すことも可能です。

replaceWithメソッドは戻り値を持ちません（void）。CDATAセクションが指定されたノードまたは文字列で置き換えられると、元のCDATAセクションノードはドキュメントから削除されます。

最後に、saveXMLメソッドを使用して、変更されたXMLドキュメントを文字列として出力し、結果を確認します。これにより、CDATAセクションがテキストノードに置き換わったXML構造が表示されます。

DOMCdataSection::replaceWithメソッドは、CDATAセクションを他のノード（テキストノードなど）や文字列で置き換える際に使用します。引数には、置き換えたいノードまたは文字列を複数指定できます。

注意点として、replaceWithメソッドは対象のノード（この場合はCDATAセクション）が属するドキュメント内でのみ有効です。別のドキュメントのノードを引数に指定するとエラーが発生する可能性があります。また、引数に指定できるのはDOMNodeオブジェクトまたは文字列のみです。それ以外のデータ型を渡すと予期せぬ動作をする可能性があります。

このメソッドは戻り値がない（void）ため、実行結果を変数に代入しても意味がありません。置換後のXML構造を確認するには、DOMDocument::saveXMLなどでドキュメント全体をシリアライズする必要があります。