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

cloneNodeメソッドは、Dom\Nodeクラスに属し、現在のDOMノードの複製を作成するメソッドです。DOMノードとは、HTMLやXML文書の各要素やテキストなどを表すものです。このメソッドを使用すると、既存のノードを元にして、全く新しい独立したノードを生成できます。

このメソッドには、deepという名前の真偽値の引数を指定できます。deepにtrue（真）を指定した場合、現在のノードだけでなく、そのノードが持つすべての子ノード（中に含まれる要素やテキストなど）も再帰的に複製されます。これにより、元のノードと全く同じ構造を持つノードツリーが作成されます。一方、deepにfalse（偽）を指定した場合は、現在のノードのみが複製され、子ノードは複製されません。

複製された新しいノードは、元のノードとは完全に独立しています。そのため、複製後に新しいノードの内容を変更しても、元のノードには影響しません。また、元のノードに設定されていたイベントリスナーは、複製されたノードにはコピーされません。ID属性を持つ要素を複製する場合、HTMLやXMLの仕様ではIDは一意であるべきため、複製後にそのIDを変更する必要がある点にご注意ください。これは、既存のDOMツリーに複製ノードを追加する際に、重複するIDを避けるためです。

Copy
1<?php
2$dom = new DOMDocument();
3$originalNode = $dom->createElement('div', 'Hello World');
4$deepClone = true; // ノードとその子孫を複製する場合は true、ノード自身のみの場合は false
5$clonedNode = $originalNode->cloneNode($deepClone);
6?>

bool $deep = false

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

Dom\Node|false

このメソッドは、呼び出し元のDom\Nodeオブジェクトのディープコピーを返します。ディープコピーとは、元のノードとその子孫ノードをすべて複製した新しいノードを生成することです。複製が成功した場合は新しいDom\Nodeオブジェクトを返し、何らかの理由で複製に失敗した場合はfalseを返します。