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

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

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

基本的な使い方

cloneNodeメソッドは、Dom\CharacterDataクラスに属し、呼び出し元のノードを複製するメソッドです。Dom\CharacterDataは、テキストノードやコメントノードなど、文字列データを保持するDOMノードの基底クラスです。このメソッドは、現在のDom\CharacterDataノードの正確なコピーを作成し、新しい独立したノードとして返します。

このメソッドは、ブール値の$deepを引数に取ります。通常、$deepがtrueなら子孫も含めて複製（ディープコピー）、falseならノード自身のみを複製（シャローコピー）します。しかし、Dom\CharacterDataクラスのノード（テキストノードやコメントノードなど）は子ノードを持ちません。そのため、この$deep引数にtrueまたはfalseのどちらを指定しても、常にノード自身のみが複製され、結果に差はありません。

複製された新しいノードは、元のノードとは完全に独立しており、DOMツリー上には自動的に挿入されるわけではありません。元のノードに変更を加えても複製されたノードには影響せず、その逆も同様です。この機能は、既存のDOMノードをテンプレートとして利用し、同じ内容を持つノードを効率的に生成したい場合に有用です。

構文(syntax)


1<?php
2
3$document = new Dom\Document();
4$characterData = $document->createTextNode('original text');
5
6// ノードの複製を生成します。
7// $deep パラメータに true を指定すると、子孫ノードも再帰的に複製されます。
8$clonedNode = $characterData->cloneNode(true);
9
10?>

引数(parameters)

bool $deep = false

bool $deep = false: クローンする際に、子ノードも含めて再帰的にクローンするかどうかを指定します。true の場合は子ノードもすべてクローンし、false の場合は自身のみをクローンします。

戻り値(return)

Dom\Node

このメソッドは、呼び出し元のノードのディープコピー（子要素もすべて含めて複製したもの）を新しい Dom\Node オブジェクトとして返します。

サンプルコード

PHP Dom\CharacterData cloneNode でノードをコピーする


1<?php
2
3// DOMDocumentを新規作成します。これはHTMLやXML文書を操作するための基盤です。
4$dom = new DOMDocument('1.0', 'UTF-8');
5$dom->formatOutput = true; // 出力されるXMLを見やすく整形します
6
7// 親となる<div>要素を作成します
8$originalDiv = $dom->createElement('div');
9$originalDiv->setAttribute('id', 'original-node'); // 識別用のIDを設定
10
11// 子要素としてテキストノードと<span>要素を作成し、親<div>に追加します
12$textNode = $dom->createTextNode('これは ');
13$originalDiv->appendChild($textNode);
14
15$spanNode = $dom->createElement('span', '子要素のテキストです');
16$originalDiv->appendChild($spanNode);
17
18// 作成した親<div>要素をDOMドキュメントに追加します（これにより`saveXML`が正しく動作します）
19$dom->appendChild($originalDiv);
20
21echo "--- オリジナルノードのXML表現 ---\n";
22echo $dom->saveXML($originalDiv) . "\n\n";
23
24// --- cloneNode(false) の例：シャローコピー（浅いコピー）---
25// originalDivをクローンしますが、$deepをfalseに設定しているため、
26// originalDiv要素自体はコピーされますが、その子ノード（テキストや<span>）はコピーされません。
27$shallowClone = $originalDiv->cloneNode(false);
28$shallowClone->setAttribute('id', 'shallow-cloned-node'); // クローンであることを示すIDを設定
29echo "--- cloneNode(false) で作成されたシャロークローン（子ノードなし） ---\n";
30echo $dom->saveXML($shallowClone) . "\n\n";
31
32// --- cloneNode(true) の例：ディープコピー（深いコピー）---
33// originalDivをクローンし、$deepをtrueに設定しているため、
34// originalDiv要素とそれに含まれる全ての子ノード（テキスト、<span>）も完全にコピーされます。
35$deepClone = $originalDiv->cloneNode(true);
36$deepClone->setAttribute('id', 'deep-cloned-node'); // クローンであることを示すIDを設定
37echo "--- cloneNode(true) で作成されたディープクローン（子ノードあり） ---\n";
38echo $dom->saveXML($deepClone) . "\n\n";
39
40?>

PHPのDom\Node::cloneNodeメソッドは、XMLやHTMLなどのDOMツリー内で既存のノードを複製するために使用されます。このメソッドは、指定されたノードのコピーを作成し、新しいノードオブジェクトとして返します。

引数$deepは、ノードをどの程度深く複製するかを制御します。デフォルト値のfalseを設定すると、「シャローコピー」（浅いコピー）が行われます。この場合、元のノード自身は複製されますが、その子ノード（テキストや他の要素など）は複製されません。一方、trueを設定すると、「ディープコピー」（深いコピー）が行われます。この場合、元のノード自身に加えて、その階層下の全ての子ノードも再帰的に複製され、完全に独立したノードツリーが作成されます。

サンプルコードでは、まずDOMDocumentを作成し、親となるdiv要素とその中にテキストノードおよびspan要素を含むオリジナルの構造を構築しています。

次に、originalDiv->cloneNode(false)を実行することで、originalDiv要素自体は複製されますが、その内部にあるテキストノードやspan要素はコピーされません。結果として、空のdiv要素が生成されることが出力で確認できます。

続いて、originalDiv->cloneNode(true)を実行すると、originalDiv要素と、その子であるテキストノード、そしてspan要素が全て完全に複製されます。これにより、元の構造と全く同じ内容を持つ新しいdiv要素が生成されることが出力から読み取れます。

このメソッドを使うことで、元のDOM構造を維持しつつ、一部だけを複製して再利用したり、異なる箇所に配置したりといった操作を効率的に行うことができます。

cloneNodeメソッドは、DOMノードをコピーする際に使用します。引数$deepがfalseの場合、ノード自身のコピー（シャローコピー）となり、その子ノードは含まれません。trueの場合、ノードとその全ての子孫ノードがコピーされるディープコピーとなります。意図しない結果を避けるため、子ノードもコピーしたい場合は必ずtrueを指定してください。クローンされたノードは、元のDOMツリーには自動的に追加されないため、必要に応じてappendChildなどで明示的に追加する必要があります。これは既存のノードに影響を与えず、独立した新しいノードとして操作するための重要なポイントです。

PHP Dom\CharacterData::cloneNode()でノードを複製する


1<?php
2
3/**
4 * Dom\CharacterData::cloneNode() メソッドのサンプルコード
5 *
6 * この関数は、DOMツリー内の文字データ（テキスト、コメントなど）を表す
7 * Dom\CharacterDataノードを複製する方法を示します。
8 * Dom\TextはDom\CharacterDataを継承したクラスの一例です。
9 * cloneNode() メソッドは、元のノードと全く同じ内容を持つ新しいノードを作成します。
10 * 引数 $deep は、Dom\CharacterDataのような子ノードを持たないノードの場合、結果に影響しません。
11 */
12function demonstrateCharacterDataCloneNode(): void
13{
14    // 1. 新しいDOMドキュメントを作成します
15    $dom = new DOMDocument('1.0', 'UTF-8');
16
17    // 2. ルート要素を作成し、ドキュメントに追加します
18    $root = $dom->createElement('example');
19    $dom->appendChild($root);
20
21    // 3. Dom\Textノード（Dom\CharacterDataのサブクラス）を作成し、ルート要素に追加します
22    $originalTextNode = $dom->createTextNode('これは元のテキストノードです。');
23    $root->appendChild($originalTextNode);
24
25    echo "元のテキストノードの内容: " . $originalTextNode->nodeValue . "\n";
26    echo "元のテキストノードのオブジェクトID: " . spl_object_id($originalTextNode) . "\n\n";
27
28    // 4. cloneNode() メソッドを使用して、テキストノードを複製します
29    // 引数 $deep は false に設定されています。
30    // Dom\CharacterDataは子ノードを持たないため、$deepがtrueでもこのケースでは結果に違いはありません。
31    /** @var \Dom\Text $clonedTextNode */
32    $clonedTextNode = $originalTextNode->cloneNode(false);
33
34    echo "複製されたテキストノードの内容: " . $clonedTextNode->nodeValue . "\n";
35    echo "複製されたテキストノードのオブジェクトID: " . spl_object_id($clonedTextNode) . "\n";
36
37    // 複製されたノードは元のノードとは異なるオブジェクトインスタンスです
38    if ($originalTextNode !== $clonedTextNode) {
39        echo "=> 複製されたノードは、元のノードとは異なる新しいインスタンスです。\n";
40    }
41
42    // 複製されたノードは、元のノードがあった場所には自動的に追加されません。
43    // 必要であれば、明示的にドキュメントに追加する必要があります。
44    // 例: $root->appendChild($clonedTextNode);
45}
46
47// 関数を実行して、Dom\CharacterData::cloneNode() の動作を確認します
48demonstrateCharacterDataCloneNode();

PHP 8のDom\CharacterData::cloneNode()メソッドは、DOMツリー内でテキストデータやコメントなどの文字データを表すノードを複製するために使用されます。Dom\CharacterDataは、Dom\TextやDom\Commentといった具体的な文字データノードの親クラスです。このメソッドを呼び出すと、元のノードと全く同じ内容を持つ、しかしメモリ上では全く別の新しいノードオブジェクトが生成されます。

サンプルコードでは、Dom\Textノードを例に、元のテキストノードを複製しています。複製されたノードは、元のノードとは異なるオブジェクトIDを持つことからもわかるように、独立したインスタンスです。これにより、元のノードに影響を与えることなく、複製されたノードを自由に操作したり、DOMツリーの別の場所に追加したりできます。

メソッドの引数$deepは、デフォルトでfalseが設定されており、子ノードを持つ要素ノードを複製する際に子ノードも一緒に複製するかどうかを制御します。しかし、Dom\CharacterData系のノードは子ノードを持たないため、この引数の値がtrueであってもfalseであっても、挙動に違いはありません。戻り値は複製された新しいDom\Nodeオブジェクトです。複製されたノードは自動的にDOMツリーに追加されるわけではないため、必要に応じてappendChild()などのメソッドを用いて明示的にツリーに組み込む必要があります。

Dom\CharacterData::cloneNode()メソッドは、元のノードの内容を保持したまま、全く新しい独立したオブジェクトとしてノードを複製します。複製されたノードは元のノードとは異なるインスタンスであり、メモリ上の別の場所に存在するため、元のノードとは完全に独立して扱われます。spl_object_id()の結果が異なることからもこの点が確認できます。複製したノードは、DOMツリーに自動的に追加されるわけではありません。使用する際は、appendChild()などのメソッドを用いて、明示的にツリー内の適切な位置へ追加する必要があります。なお、Dom\CharacterDataは子ノードを持たないため、引数$deepをtrueに設定してもfalseに設定しても動作に違いはありません。この引数は、子ノードを持つノードの複製時に、その子ノードも複製するかどうかを制御するものです。