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

importNodeメソッドは、指定されたノードを別のドキュメントから現在のドキュメントへインポートするメソッドです。

このメソッドは、XMLやHTMLのドキュメントオブジェクトモデル（DOM）を操作する際に非常に重要で、異なるドキュメントに属するノードを、現在作業しているドキュメントのコンテキストで利用できるようにするために使用されます。具体的には、引数として渡されたノード（要素、テキスト、コメントなど）のクローンを作成し、そのクローンを現在のドキュメントに属するものとして返します。元のドキュメント内の元のノードは、変更されることなくそのまま残ります。

importNodeメソッドには、第二引数として$deepというブール値を指定できます。この$deepにtrueを設定した場合、インポート対象のノードだけでなく、そのノードのすべての子孫ノード（子要素やそのさらに子要素など）も再帰的にインポートされ、新しいドキュメントのコンテキストに適合するようクローンされます。一方、$deepにfalseを設定すると、インポート対象のノードのみがインポートされ、その子孫ノードは含まれません。

この機能は、例えば、テンプレートとして作成された別のHTMLドキュメントから特定のセクションや要素を取り出し、現在のHTMLドキュメントに組み込む際などに非常に役立ちます。これにより、異なるドキュメント構造を持つデータを効率的に統合・利用することが可能になります。

Copy
1<?php
2
3$targetDocument = new Dom\HTMLDocument(); // ノードをインポートする先のHTMLドキュメント
4$sourceDocument = new Dom\HTMLDocument(); // インポート元となるノードを含むHTMLドキュメント
5$sourceDocument->loadHTML('<div><p>インポートするノード</p></div>');
6
7$nodeToImport = $sourceDocument->getElementsByTagName('p')->item(0); // インポートしたいDom\Nodeオブジェクト
8$deep = true; // ノードの子孫も再帰的にインポートするか (true:する, false:しない)
9
10// Dom\HTMLDocument::importNode メソッドの構文
11$importedNode = $targetDocument->importNode($nodeToImport, $deep);
12
13?>

Dom\Node $node, bool $deep = false

• Dom\Node $node: インポートしたいDOMノード
• bool $deep = false: trueの場合、指定したノードの子孫ノードもすべてインポートします。デフォルトはfalseで、ノード自身のみをインポートします。

Dom\Node

指定されたDOM (Document Object Model) のノードを、現在のHTMLドキュメントのコンテキストでインポートした新しいノードを返します。この新しいノードは、元のノードの構造と内容を保持していますが、DOMツリー内での配置は異なります。