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

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

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

基本的な使い方

cloneNodeメソッドは、Dom\Documentクラスに属するメソッドであり、ノードの複製（クローン）を作成するために使用されます。具体的には、このメソッドは、ドキュメント内のノード（要素、属性、テキストなど）の完全なコピーを生成し、そのコピーを返します。

cloneNodeメソッドは、オプションの引数$deepを受け取ります。$deep引数はboolean型で、デフォルトはfalseです。

$deepがfalseの場合（浅いコピー）、ノード自体のみが複製され、その子ノードは複製されません。つまり、新しいノードは元のノードと同じ属性を持ちますが、子ノードは持ちません。

$deepがtrueの場合（深いコピー）、ノードとそのすべての子ノードが再帰的に複製されます。これは、元のノードの完全なコピーを作成する場合に役立ちます。新しいノードは、元のノードと全く同じ構造と内容を持つことになります。

このメソッドは、既存のドキュメント構造を変更せずに、新しいノードを生成したり、別の場所に挿入したりする場合に非常に便利です。例えば、テンプレートとして使用するノードを複製し、必要なデータを設定してからドキュメントに追加する、といった使い方ができます。

戻り値は、複製された新しいDom\Nodeオブジェクトです。もし複製に失敗した場合（例えば、メモリ不足など）、falseが返される可能性があります。

構文(syntax)


1Dom\Document::cloneNode(bool $deep = true): Dom\Node

引数(parameters)

bool $deep = false

bool $deep = false: trueを指定すると、ノードとそのすべての子孫ノードを再帰的にコピーします。falseを指定すると、ノード自身のみをコピーします。

戻り値(return)

Dom\Node

Dom\Document::cloneNodeメソッドは、呼び出したノードのディープコピーを返します。このコピーは、元のノードと同じ要素タイプ、属性、子ノードを持っています。

サンプルコード

PHP DOM DocumentのcloneNodeでノードを複製する


1<?php
2
3/**
4 * Dom\Document::cloneNode メソッドの使用例
5 * 
6 * PHP DOM拡張機能におけるノードのクローン（複製）方法を示します。
7 * Dom\Document クラスは Dom\Node を継承しているため、cloneNode メソッドを使用できます。
8 * 
9 * @param bool $deep ドキュメントの子孫ノードもクローンするかどうか。
10 *                     true の場合、ノードとそのすべての子孫がクローンされます。
11 *                     false の場合、ノード自身のみがクローンされ、子孫はクローンされません。
12 * @return Dom\Document クローンされた新しい Dom\Document オブジェクト。
13 */
14function demonstrateDomDocumentCloneNode(): void
15{
16    // 1. オリジナルのDom\Documentを作成し、要素を追加してツリー構造を作る
17    $originalDoc = new Dom\Document('1.0', 'UTF-8');
18    $originalDoc->formatOutput = true; // 出力を見やすくする
19
20    $rootElement = $originalDoc->createElement('root');
21    $originalDoc->appendChild($rootElement);
22
23    $childElement1 = $originalDoc->createElement('child1', 'これは最初の子ノードです。');
24    $rootElement->appendChild($childElement1);
25
26    $childElement2 = $originalDoc->createElement('child2');
27    $rootElement->appendChild($childElement2);
28
29    $grandchildElement = $originalDoc->createElement('grandchild', 'これは孫ノードです。');
30    $childElement2->appendChild($grandchildElement);
31
32    echo "--- オリジナル ドキュメントのXML ---\n";
33    echo $originalDoc->saveXML();
34    echo "\n";
35
36    // 2. cloneNode を使用してドキュメントを深くクローン（子孫ノードも含む）
37    // $deep = true: オリジナルドキュメントのすべてのノードが、新しいドキュメントにコピーされます。
38    // 戻り値の型は Dom\Node ですが、実際には Dom\Document のインスタンスが返されます。
39    $deepClonedDoc = $originalDoc->cloneNode(true);
40
41    echo "--- ディープクローンされたドキュメント (deep = true) ---\n";
42    echo $deepClonedDoc->saveXML();
43    echo "\n";
44
45    // 3. cloneNode を使用してドキュメントを浅くクローン（子孫ノードを含まない）
46    // $deep = false: ドキュメントノード自体はコピーされますが、
47    // その子ノード（'root'要素、'child1'要素など）はコピーされません。
48    // そのため、結果はXML宣言のみの空のドキュメントになります。
49    $shallowClonedDoc = $originalDoc->cloneNode(false);
50
51    echo "--- シャロークローンされたドキュメント (deep = false) ---\n";
52    echo $shallowClonedDoc->saveXML(); // <?xml version="1.0" encoding="UTF-8"?> のみが出力されます
53    echo "\n";
54
55    // 注意点: クローンされたドキュメントは、オリジナルのドキュメントとは完全に独立したオブジェクトです。
56    // 例: deepClonedDoc の内容を変更しても originalDoc には影響しません。
57    // 例: シャロークローンされたドキュメントに要素を追加してみる
58    $newRootForShallow = $shallowClonedDoc->createElement('new_root', 'シャロークローン後に追??加されたルート');
59    $shallowClonedDoc->appendChild($newRootForShallow);
60    echo "--- シャロークローン後、要素を追加したドキュメント ---\n";
61    echo $shallowClonedDoc->saveXML();
62    echo "\n";
63}
64
65// 関数の実行
66demonstrateDomDocumentCloneNode();

PHP 8のDom\Document::cloneNodeメソッドは、XMLやHTMLなどのDOMツリー構造を扱う際に、特定のノードを複製するために利用されます。このメソッドはDom\Nodeクラスから継承されており、Dom\Documentオブジェクトに対しても適用可能です。

このメソッドには$deepというブール型の引数があり、ノードを複製する深さを指定します。$deepにtrueを指定すると、元のノードだけでなく、そのノードが持つすべての子孫ノード（子ノード、孫ノードなど）もまとめて深く複製（ディープクローン）されます。これにより、元のDOMツリー構造全体が、新しいオブジェクトとして完全に独立してコピーされます。

一方、$deepにfalseを指定すると、ノード自身のみが複製され、その子孫ノードは含まれません（シャロークローン）。Dom\Documentオブジェクトの場合、falseを指定するとXML宣言のみを持つ実質的に空のドキュメントが生成されます。

メソッドの戻り値は複製された新しいDom\Nodeオブジェクトですが、Dom\Documentに対して使用した場合は、新しいDom\Documentオブジェクトが返されます。複製されたオブジェクトは元のオブジェクトとは完全に独立しているため、どちらかの内容を変更しても、もう一方に影響を与えることはありません。サンプルコードでは、深く複製されたドキュメントは元の内容を完全に持ち、浅く複製されたドキュメントは空になる挙動が示されています。

Dom\Document::cloneNodeは、元のドキュメントとは独立した複製を作成します。最大の注意点は引数$deepです。trueを指定すると、ドキュメントの全内容（子孫ノード含む）が複製されます。しかしfalseの場合、ドキュメントノード自体は複製されますが、XML宣言部分以外の子孫ノードは含まれず、ほぼ空のドキュメントとなるため、注意が必要です。戻り値の型はDom\Nodeですが、実際にはDom\Documentのインスタンスが返されるため、クローン後もドキュメントとしてそのまま利用できます。

PHP DomDocument cloneNode でノードを複製する


1<?php
2
3// Dom\Document::cloneNode メソッドのサンプルコード
4// このメソッドは、XML/HTML ドキュメントを表現する Dom\Document オブジェクトを複製します。
5
6// 1. 新しい Dom\Document インスタンスを作成
7$originalDoc = new Dom\Document();
8
9// 2. シンプルなHTMLコンテンツをロード
10// <<<HTML ... HTML; は heredoc 構文で、複数行の文字列を記述するのに便利です。
11$htmlContent = <<<HTML
12    <html>
13    <head><title>Original Document</title></head>
14    <body>
15        <h1>Hello, Original!</h1>
16        <p>This is the original paragraph.</p>
17    </body>
18    </html>
19HTML;
20$originalDoc->loadHTML($htmlContent);
21
22echo "--- 元のドキュメントの内容 ---\n";
23// saveHTML() メソッドで Dom\Document オブジェクトの内容をHTML文字列として出力します。
24echo $originalDoc->saveHTML();
25echo "\n";
26
27// 3. cloneNode メソッドを使ってドキュメントをクローンする
28// cloneNode メソッドは、呼び出されたノード（ここでは $originalDoc）の複製を作成します。
29// 引数 $deep は、複製が「深いコピー」になるか「浅いコピー」になるかを制御します。
30// - true に設定すると (ディープコピー): 元のドキュメントのすべての子ノード（要素、テキスト、属性など）も再帰的に複製されます。
31// - false に設定した場合 (シャローコピー): ドキュメントノード自体のみが複製され、その子ノードは含まれません。
32//   Dom\Document の場合は通常、ドキュメント全体を複製するため $deep を true に設定することがほとんどです。
33$clonedDoc = $originalDoc->cloneNode(true);
34
35// cloneNode メソッドは Dom\Node 型を返しますが、Dom\Document オブジェクトに対して呼び出した場合、
36// 実際には Dom\Document 型の新しいインスタンスが返されるため、Dom\Document として引き続き操作できます。
37
38// 4. クローンされたドキュメントの内容を出力
39echo "--- クローンされたドキュメントの内容 (deep copy) ---\n";
40echo $clonedDoc->saveHTML();
41echo "\n";
42
43// ヒント:
44// クローンされたドキュメント ($clonedDoc) は、元のドキュメント ($originalDoc) とは
45// 完全に独立した新しいオブジェクトです。
46// 一方のドキュメントの内容を変更しても、もう一方のドキュメントには影響しません。
47
48?>

PHPのDom\Document::cloneNodeメソッドは、XMLやHTMLドキュメントを表現するDom\Documentオブジェクトを複製するために使用されます。このメソッドを呼び出すと、元のドキュメントの内容が新しいDom\Documentオブジェクトとしてコピーされます。

引数$deepは、複製方法を制御する重要なブール値です。trueを指定すると「ディープコピー」が行われ、元のドキュメントのすべての要素、テキスト、属性といった子ノードが再帰的に新しいドキュメントにコピーされます。これにより、元のドキュメントとまったく同じ内容を持つ独立したドキュメントが得られます。一方、falseを指定すると「シャローコピー」となり、ドキュメントノード自体は複製されますが、その子ノードは含まれません。Dom\Documentオブジェクトを複製する場合、通常はドキュメント全体を複製するため$deepにはtrueを設定することがほとんどです。

このメソッドの戻り値はDom\Node型ですが、Dom\Documentオブジェクトに対して呼び出した場合は、新しいDom\Documentインスタンスが返されます。複製されたドキュメントは、元のドキュメントとは完全に独立したオブジェクトであるため、一方を変更してももう一方には影響しません。これにより、元のドキュメントを保持したまま、そのコピーを自由に操作することが可能になります。

cloneNodeメソッドをご利用の際は、引数$deepの指定が特に重要です。trueを設定すると、元のドキュメントの全ての子ノードを含め、完全に複製されます（ディープコピー）。Dom\Documentオブジェクト全体を複製したい場合は、通常trueを指定します。falseの場合、ドキュメントノード自体は複製されますが、その子ノードは含まれませんのでご注意ください。このメソッドはDom\Node型を返しますが、Dom\Documentオブジェクトに対して呼び出した場合、実際にはDom\Document型の新しいインスタンスが返されます。クローンされたドキュメントは元のドキュメントとは完全に独立しており、一方の変更がもう一方に影響することはありませんので、安全に別のドキュメントとして操作いただけます。