【PHP8.x】cloneNodeメソッドの使い方

cloneNodeメソッドは、DOMツリー内に存在するノードの複製を作成するメソッドです。このメソッドは、DOMElementクラスのインスタンスに対して呼び出され、HTMLやXMLドキュメント内の要素を効率的に複製する際に使用されます。

このメソッドは、ブール型の引数$deepを受け取ります。$deepにtrueを指定すると、現在のノードだけでなく、そのすべての子ノードや属性も再帰的に複製されます。これを「ディープコピー」と呼びます。一方、$deepにfalseを指定すると、現在のノード自身のみが複製され、子ノードは複製されません。これを「シャローコピー」と呼びます。ディープコピーは元のノードと全く同じ構造を持つ新しいノードツリーを作成したい場合に、シャローコピーは子要素を含まない新しいノードが必要な場合に適しています。

cloneNodeメソッドは、複製された新しいDOMNodeオブジェクトを返します。この複製されたノードは、元のノードとは独立した新しいインスタンスであり、元のドキュメントツリーには自動的には追加されません。実際にドキュメントに組み込むには、appendChildやinsertBeforeなどのDOM操作メソッドを使って明示的に追加する必要があります。この機能により、既存のDOM構造を再利用し、ウェブページの動的なコンテンツ生成や更新を柔軟に実現できます。

Copy
1<?php
2// DOMElement のインスタンスを作成
3$originalElement = new DOMElement('div');
4
5// cloneNode メソッドを呼び出す
6// 引数 $deep に true を指定すると、子ノードも含めて再帰的にクローンされます
7$clonedElement = $originalElement->cloneNode(true);

bool $deep = false

• bool $deep = false: trueを指定すると、ノードとそのすべての子孫ノードを再帰的にコピーします。false（デフォルト）を指定すると、ノード自身のみがコピーされ、子ノードはコピーされません。

DOMNode|false

DOMElementオブジェクトのディープコピーを返します。コピーに失敗した場合はfalseを返します。