いっしー@Webエンジニア
Webツールプログラミング言語プログラミング学習ITニュースIT用語辞典ポートフォリオ
Webエンジニア向けプログラミング解説動画をYouTubeで配信中！
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

cloneNodeメソッドは、Dom\Elementオブジェクトの複製（クローン）を作成するメソッドです。PHPのDOM拡張モジュールで使用され、XMLやHTMLドキュメントの要素を操作する際に役立ちます。このメソッドを使用すると、元の要素の構造や属性を保持した新しい要素を生成できます。

cloneNodeメソッドには、オプションで深い複製（deep clone）を指定する引数を渡すことができます。この引数がtrueの場合、要素とそのすべての子ノードが複製されます。false（または省略した場合）の場合、要素自体のみが複製され、子ノードは複製されません。

具体的には、ある要素の内容を別の場所にコピーしたい場合や、要素の属性を保持したまま新しい要素を作成したい場合などに利用されます。例えば、HTMLフォームの入力フィールドを複製して複数の同じフィールドを作成したり、XMLドキュメントの特定のセクションをコピーして別の場所に挿入したりする用途が考えられます。

cloneNodeメソッドは、元の要素を変更せずに複製を作成するため、データ構造を安全に操作できます。また、深い複製を行うことで、複雑な要素構造を簡単に再利用できるため、開発効率の向上に貢献します。このメソッドは、DOMドキュメントの構造を動的に変更する必要がある場合に非常に有用であり、システムエンジニアがWebアプリケーションやXML処理を行う際に頻繁に使用する機能の一つです。

構文(syntax)

1Dom\Element::cloneNode(bool $deep = false): Dom\Node

引数(parameters)

bool $deep = false

  • bool $deep = false: ノードとそのすべての子孫をディープコピーするかどうかを指定するブール値。true の場合、ノードとそのすべての子孫がコピーされます。false の場合、ノードのみがコピーされ、子ノードはコピーされません。デフォルトは false です。

戻り値(return)

Dom\Node

このメソッドは、元のDOM要素のディープコピー（子要素もすべて含む）をDom\Nodeオブジェクトとして返します。

サンプルコード

PHP Dom\Element::cloneNode でノードを複製する

1<?php
2
3/**
4 * Dom\Element::cloneNode メソッドの動作をデモンストレーションする関数。
5 * DOMノードの複製（コピー）について、システムエンジニアを目指す初心者にも分かりやすく解説します。
6 *
7 * キーワード「php clone とは」について補足:
8 * PHPの `clone` キーワードは一般的なオブジェクトの複製に使われますが、
9 * DOM操作におけるノードの複製には `Dom\Element::cloneNode()` メソッドを使用します。
10 */
11function demonstrateDomElementCloneNode(): void
12{
13    // 1. DOMDocument を新規作成し、HTMLコンテンツをロードします。
14    // 複製対象となる<div>要素と、その中に子要素<span>と<p>を含みます。
15    $dom = new DOMDocument();
16    // 完全なHTML構造を提供することで、loadHTMLが警告を出さないようにします。
17    $html = '<!DOCTYPE html><html><head><meta charset="utf-8"></head><body><div id="originalDiv"><span>オリジナルテキスト</span><p>別の要素</p></div></body></html>';
18    $dom->loadHTML($html);
19
20    // 2. 複製したい Dom\Element を ID を指定して取得します。
21    // ここでは 'originalDiv' という ID を持つ<div>要素を取得します。
22    $originalDiv = $dom->getElementById('originalDiv');
23
24    if (!$originalDiv) {
25        echo "エラー: ID 'originalDiv' を持つ要素が見つかりませんでした。\n";
26        return;
27    }
28
29    echo "--- オリジナルノードの情報 ---\n";
30    echo "ノード名: " . $originalDiv->nodeName . "\n";
31    echo "子ノード数: " . $originalDiv->childNodes->length . "\n";
32    echo "HTML: " . $dom->saveHTML($originalDiv) . "\n\n";
33
34    // 3. Dom\Element::cloneNode(true) を使用して、ディープコピーを行います。
35    // 引数 `$deep = true` は、ノード自身と、そのすべての子孫ノードを複製することを意味します。
36    echo "--- ディープコピー (cloneNode(true)) の例 ---\n";
37    $clonedDivDeep = $originalDiv->cloneNode(true);
38
39    // 複製されたノードが Dom\Element であることを確認し、識別用のIDを設定します。
40    // cloneNodeの戻り値はDom\Nodeですが、多くの場合Dom\Elementになります。
41    if ($clonedDivDeep instanceof Dom\Element) {
42        $clonedDivDeep->setAttribute('id', 'clonedDivDeep');
43    }
44
45    echo "複製されたノード名: " . $clonedDivDeep->nodeName . "\n";
46    echo "複製された子ノード数: " . $clonedDivDeep->childNodes->length . "\n";
47    echo "複製されたHTML: " . $dom->saveHTML($clonedDivDeep) . "\n";
48    echo "説明: オリジナルノードの子要素（<span>や<p>）も全て複製されています。\n\n";
49
50
51    // 4. Dom\Element::cloneNode(false) を使用して、シャローコピーを行います。
52    // 引数 `$deep = false` は、ノード自身のみを複製し、子孫ノードは複製しないことを意味します。
53    echo "--- シャローコピー (cloneNode(false)) の例 ---\n";
54    $clonedDivShallow = $originalDiv->cloneNode(false);
55
56    // 複製されたノードが Dom\Element であることを確認し、識別用のIDを設定します。
57    if ($clonedDivShallow instanceof Dom\Element) {
58        $clonedDivShallow->setAttribute('id', 'clonedDivShallow');
59    }
60
61    echo "複製されたノード名: " . $clonedDivShallow->nodeName . "\n";
62    echo "複製された子ノード数: " . $clonedDivShallow->childNodes->length . "\n";
63    echo "複製されたHTML: " . $dom->saveHTML($clonedDivShallow) . "\n";
64    echo "説明: オリジナルノードの子要素は複製されず、空の<div>が複製されています。\n\n";
65
66    // 補足: cloneNodeで複製されたノードは、元のDOMツリーには自動的に追加されません。
67    // 必要に応じて DOMDocument::appendChild() などを使ってDOMツリーに追加する必要があります。
68}
69
70// 上記のデモンストレーション関数を実行します。
71demonstrateDomElementCloneNode();

PHPのDom\Element::cloneNodeメソッドは、既存のDOMノードを複製（コピー）するために使用されます。これは、HTMLやXMLのようなツリー構造を持つ文書を操作する際に、同じ構造を持つ要素を繰り返し作成したい場合などに非常に便利です。一般的なPHPオブジェクトの複製にはcloneキーワードが使われますが、DOM操作においてはcloneNode()メソッドを用いる点が特徴です。

このメソッドはbool $deep = falseという引数を取ります。$deepにtrueを指定すると、元のノード自身だけでなく、そのノードが持つすべての子孫ノード（子要素、テキストノードなど）も一緒に複製されます。これを「ディープコピー」と呼びます。一方、falseを指定するか省略すると、ノード自身のみが複製され、子孫ノードは複製されません。これを「シャローコピー」と呼びます。戻り値は複製された新しいDom\Nodeオブジェクトです。

サンプルコードでは、まずHTMLコンテンツを持つDOMDocumentを作成し、id="originalDiv"を持つ<div>要素を複製元として取得しています。最初に$originalDiv->cloneNode(true)を実行することで、originalDivとその内部にある<span>や<p>といった子要素も含めて完全に複製（ディープコピー）されています。複製後の子ノード数が増えていることで確認できます。次に$originalDiv->cloneNode(false)を実行すると、originalDiv要素自体は複製されますが、その子要素は含まれず、空の<div>要素が複製されます（シャローコピー）。複製後の子ノード数が0になることで確認できます。複製されたノードは、元のDOMツリーには自動的に追加されないため、必要に応じてappendChildなどのメソッドを使って手動で追加する必要があります。

「php clone とは」について、DOM操作でノードを複製する際は、PHPの一般的なオブジェクト複製に使うcloneキーワードではなく、Dom\Element::cloneNode()メソッドを使用します。このメソッドの引数$deepが重要で、trueを指定するとノード自身と子孫ノード全てを複製する「ディープコピー」、falseだとノード自身のみを複製する「シャローコピー」となります。この違いを明確に理解してください。

cloneNode()で複製されたノードは、元のDOMツリーには自動的に追加されません。新しいノードをDOMツリーに組み込むには、appendChild()などのメソッドを別途呼び出す必要があります。また、複製されたノードは元のIDを引き継ぐため、DOMツリーに追加する際はIDの重複に注意し、必要に応じて変更してください。

PHP cloneNodeで要素をコピーする

1<?php
2
3// DOMDocumentオブジェクトを生成し、HTML要素を操作するための準備をします。
4// システムエンジニアを目指す初心者の方も、HTMLのDOM構造を扱う基本として理解しましょう。
5$dom = new DOMDocument('1.0', 'UTF-8');
6$dom->formatOutput = true; // 出力を整形して見やすくします
7
8// クローンする元のDom\Elementを作成します。
9// ここでは'div'要素を作成し、id属性と子要素を追加しています。
10$originalElement = $dom->createElement('div');
11$originalElement->setAttribute('id', 'original-div');
12$originalElement->appendChild($dom->createTextNode('Original text. '));
13
14// 子要素としてspanを作成し、さらにテキストノードを追加します。
15$childElement = $dom->createElement('span');
16$childElement->setAttribute('class', 'child');
17$childElement->appendChild($dom->createTextNode('This is a child span.'));
18$originalElement->appendChild($childElement);
19
20// 元の要素のHTML表現を出力します。
21echo "--- Original Element ---\n";
22echo $dom->saveHTML($originalElement);
23echo "\n\n";
24
25// Dom\Element::cloneNode(false) の使用例: シャローコピー（浅いコピー）
26// 第1引数に 'false' を渡すと、要素自身と属性のみがコピーされ、子要素はコピーされません。
27// 戻り値は Dom\Node オブジェクトですが、元の要素が Dom\Element なので、返されるのも Dom\Element になります。
28$shallowClone = $originalElement->cloneNode(false);
29$shallowClone->setAttribute('id', 'shallow-cloned-div'); // コピーであることを示すためIDを変更
30
31echo "--- Shallow Clone (cloneNode(false)) ---\n";
32echo "Type of shallow clone: " . get_class($shallowClone) . "\n"; // Dom\Elementであることを確認
33echo $dom->saveHTML($shallowClone);
34echo "\n\n";
35
36// Dom\Element::cloneNode(true) の使用例: ディープコピー（深いコピー）
37// 第1引数に 'true' を渡すと、要素自身、属性、そしてすべての子要素が再帰的にコピーされます。
38// 元の要素のDOMツリー全体が複製されます。
39$deepClone = $originalElement->cloneNode(true);
40$deepClone->setAttribute('id', 'deep-cloned-div'); // コピーであることを示すためIDを変更
41
42// ディープコピーされた子要素の内容を変更して、元の要素とは独立していることを示します。
43if ($deepClone instanceof Dom\Element) {
44    // ディープコピーされたdivの子要素（span）を探して変更
45    foreach ($deepClone->childNodes as $node) {
46        if ($node instanceof Dom\Element && $node->tagName === 'span') {
47            $node->setAttribute('class', 'deep-cloned-modified-child');
48            // 既存のテキストノードを更新
49            foreach ($node->childNodes as $childNode) {
50                if ($childNode instanceof DOMText) {
51                    $childNode->nodeValue = 'This is a modified deep-cloned child span.';
52                    break;
53                }
54            }
55            break;
56        }
57    }
58}
59
60echo "--- Deep Clone (cloneNode(true)) ---\n";
61echo "Type of deep clone: " . get_class($deepClone) . "\n"; // Dom\Elementであることを確認
62echo $dom->saveHTML($deepClone);
63echo "\n";
64
65?>

Dom\Element::cloneNodeメソッドは、HTMLなどのドキュメントオブジェクトモデル（DOM）ツリー内の特定の要素を複製するために使用されます。

このメソッドはbool $deepという引数を持ち、要素の複製方法を制御します。引数がfalse（デフォルト値）の場合、要素自身とそれに設定された属性のみがコピーされます。これを「シャローコピー（浅いコピー）」と呼び、元の要素が持つ子要素は複製に含まれません。

一方、引数にtrueを指定すると、「ディープコピー（深いコピー）」が行われます。この場合、要素自身、属性、そしてその要素が持っているすべての子要素（子孫要素も含む）が再帰的に完全に複製されます。これにより、元の要素と全く同じ構造を持つ新しいDOMツリーが生成されます。

メソッドの戻り値はDom\Node型ですが、元の要素がDom\Elementであった場合、返される複製された要素もDom\Elementとして扱えます。

サンプルコードでは、まず子要素を持つ元のdiv要素を作成し、cloneNode(false)で子要素を含まないシャローコピーを、次にcloneNode(true)で子要素まで完全に複製されたディープコピーを作成し、それぞれの挙動の違いを示しています。

この機能は、既存のDOM要素の構造を基に、独立した新しい要素群を効率的に生成したい場合に非常に有用です。

cloneNode()メソッドは、DOM要素を複製する際に使用します。引数にfalse（デフォルト）を指定すると、要素自身とその属性のみをコピーする「シャローコピー」となり、子要素は複製されません。一方、trueを指定すると、要素、属性、そしてすべての子要素も再帰的にコピーする「ディープコピー」となります。複製された要素は元の要素とは独立した新しいオブジェクトであり、コピーを変更しても元の要素には影響しません。メソッドの戻り値はDom\Node型ですが、元の要素がDom\Elementであれば通常Dom\Elementのインスタンスが返されます。クローンした要素を実際のDOMツリーに追加するには、別途appendChildなどのメソッドを使う必要がある点にご注意ください。

関連コンテンツ

関連IT用語

関連プログラミング言語