【PHP8.x】childNodesプロパティの使い方

childNodesプロパティの使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

childNodesプロパティは、Dom\DocumentFragmentクラスに属する読み取り専用のプロパティで、ノードの子ノードリスト（DomNodeListオブジェクト）を保持するプロパティです。Dom\DocumentFragmentは、ドキュメントの一部を表現するために使用される軽量なノードです。

このプロパティを使用することで、Dom\DocumentFragmentノードが持つすべての子ノードにアクセスできます。子ノードは、要素ノード、テキストノード、コメントノードなど、様々な種類のノードを含み得ます。取得されるDomNodeListオブジェクトは、ノードが追加、削除、または置換されると自動的に更新されます。

システムエンジニアを目指す初心者にとって、childNodesプロパティは、ドキュメントフラグメント内のノードを効率的に処理するための重要なツールとなります。例えば、DOM操作を行う際に、特定のドキュメントフラグメントから全ての子ノードを取得し、それらを別の場所に移動したり、特定の条件に基づいてフィルタリングしたりする処理を実装できます。

このプロパティは読み取り専用であるため、直接値を変更することはできません。子ノードリストを変更するには、DomNodeクラスのメソッド（例えば、appendChild、removeChild、replaceChildなど）を使用する必要があります。

childNodesプロパティを使用する際には、返されるDomNodeListオブジェクトがライブリストであることに注意が必要です。つまり、リストに対する変更（例えば、ノードの追加や削除）は、Dom\DocumentFragmentノード自体に即座に反映されます。そのため、リストを反復処理中にノードを追加または削除すると、予期しない動作が発生する可能性があります。反復処理中にリストを変更する必要がある場合は、リストのコピーを作成して、コピーに対して操作を行うことを推奨します。

構文(syntax)


1readonly public Dom\NodeList $childNodes

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMNodeList

childNodes プロパティは、Dom\DocumentFragment オブジェクトの子ノードのリストである DOMNodeList を返します。このリストには、要素ノード、テキストノード、コメントノードなどが含まれます。

サンプルコード

PHP DOM DocumentFragment の childNodes を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\DocumentFragment の childNodes プロパティの使用例を示します。
7 *
8 * DocumentFragmentは、ドキュメントの一部を保持するための軽量なコンテナです。
9 * childNodesプロパティは、このフラグメントに含まれる全ての子ノードのリスト(DOMNodeList)を返します。
10 */
11function demonstrateDocumentFragmentChildNodes(): void
12{
13    // 1. DOMDocument オブジェクトを作成
14    $dom = new DOMDocument();
15
16    // 2. DocumentFragment オブジェクトを作成
17    $fragment = $dom->createDocumentFragment();
18
19    // 3. フラグメントに複数の子ノード（要素やテキスト）を追加
20    $p = $dom->createElement('p', 'これは段落です。');
21    $div = $dom->createElement('div', 'これはdiv要素です。');
22    $text = $dom->createTextNode('これは単なるテキストノードです。');
23
24    $fragment->appendChild($p);
25    $fragment->appendChild($div);
26    $fragment->appendChild($text);
27
28    // 4. childNodes プロパティを使って、フラグメント内のすべての子ノードを取得
29    //    戻り値は DOMNodeList オブジェクトです。
30    $childNodes = $fragment->childNodes;
31
32    // 5. DOMNodeList をループ処理し、各子ノードの情報を出力
33    echo "DocumentFragment の子ノード一覧:" . PHP_EOL;
34    echo "----------------------------" . PHP_EOL;
35
36    // DOMNodeList は foreach で直接イテレートできます。
37    foreach ($childNodes as $index => $node) {
38        // nodeName: ノード名（例: 'p', 'div', '#text'）
39        // textContent: ノードとその子孫に含まれるテキスト内容
40        printf(
41            "[%d] ノード名: %s, 内容: \"%s\"" . PHP_EOL,
42            $index,
43            $node->nodeName,
44            trim($node->textContent)
45        );
46    }
47}
48
49// 関数を実行して結果を表示
50demonstrateDocumentFragmentChildNodes();
51
52?>

PHP 8のDom\DocumentFragmentクラスが提供するchildNodesプロパティは、HTMLやXMLドキュメントの一部を効率的に扱うための軽量なコンテナであるDocumentFragmentオブジェクトに含まれる、すべての子ノードのリストを取得するために使用されます。

このプロパティに引数はなく、戻り値としてDOMNodeListオブジェクトを返します。DOMNodeListは、子ノードの集合を表すもので、foreachループなどを用いてリスト内の各ノードにアクセスし、それぞれのノードの情報を取得したり操作したりすることが可能です。

サンプルコードでは、まずDOMDocumentとDocumentFragmentを作成し、その後、段落（）、div要素、テキストノードなど複数の子ノードをDocumentFragmentに追加しています。$fragment->childNodesという形でこのプロパティを利用することで、フラグメントに追加されたすべての子ノードをDOMNodeListとして取得できます。取得したDOMNodeListは、foreachループで反復処理され、各子ノードのノード名や内容が一覧表示されることで、DocumentFragmentが保持する子ノードを簡単に確認できる様子を示しています。

Dom\DocumentFragmentは、直接描画されないメモリ上の仮想的なDOM構造です。そのchildNodesプロパティが返すDOMNodeListは、フラグメントの子ノードのリストであり、これは動的なコレクションである点にご注意ください。リスト取得後にフラグメントの内容を変更すると、DOMNodeListも自動的に更新されるため、ループ中にフラグメントのノードを操作すると、予期せぬ結果を招く可能性があります。DOMNodeListは配列のように見えますが、PHPの標準配列関数は直接適用できませんので、foreachなどで個別に処理してください。また、ノードの内容を取得するtextContentは、不要な空白や改行を含むことがあるため、trim()関数で整形すると扱いやすくなります。

PHP DomDocumentFragment childNodes と XPath


1<?php
2
3/**
4 * Dom\DocumentFragment の childNodes プロパティと XPath の使用例を示します。
5 *
6 * このコードは、PHP 8 の Dom 拡張機能を使用して、DOMツリーの操作とノードリストの扱いを説明します。
7 * Dom\DocumentFragment は、一時的なノードのコンテナとして機能し、その内容を
8 * 実際の Dom\Document に挿入する前に効率的に構築するのに便利です。
9 * childNodes プロパティは、ノードの直接の子ノードのリスト (Dom\NodeList) を提供します。
10 * XPath は、DOMツリーから特定のノードを強力なパターンマッチングで選択するための言語です。
11 */
12function demonstrateDomDocumentFragmentChildNodesAndXPath(): void
13{
14    // Dom\DocumentFragment はそれ自体ではノードを作成できないため、ノード作成用の Dom\Document を使用します。
15    $documentForNodes = new Dom\Document();
16
17    // 1. Dom\DocumentFragment を作成し、ノードを追加する
18    $fragment = new Dom\DocumentFragment();
19
20    // いくつかの <p> 要素と、その中に <span> を含む要素を作成し、フラグメントに追加します。
21    $p1 = $documentForNodes->createElement('p', 'This is the first paragraph in the fragment.');
22    $p2 = $documentForNodes->createElement('p', 'This is the second paragraph with a ');
23    $span = $documentForNodes->createElement('span', 'span element');
24    $p2->appendChild($span); // <span> を <p2> の子ノードとして追加
25    $p2->appendChild($documentForNodes->createTextNode('.')); // テキストノードを <p2> の最後に追加
26
27    $fragment->appendChild($p1); // <p1> をフラグメントに追加
28    $fragment->appendChild($p2); // <p2> をフラグメントに追加
29
30    echo "--- Dom\\DocumentFragment::childNodes の例 ---\n";
31    echo "フラグメントに直接追加された子ノード (Dom\\NodeList):\n";
32    // Dom\DocumentFragment の childNodes プロパティは Dom\NodeList を返します。
33    // Dom\NodeList は foreach で直接ループできます。
34    foreach ($fragment->childNodes as $node) {
35        if ($node instanceof Dom\Element) {
36            echo "  - 要素ノード: <" . $node->tagName . "> (コンテンツ: '" . $node->textContent . "')\n";
37        }
38    }
39    echo "\n";
40
41    // 2. Dom\DocumentFragment の内容を実際の Dom\Document にインポートする
42    $mainDocument = new Dom\Document();
43    // 基本的なHTML構造をロードし、フラグメントを挿入するための場所 (`<div id="container">`) を用意します。
44    $mainDocument->loadHTML('<html><body><div id="container"></div></body></html>');
45    
46    // id="container" の要素を見つける
47    $container = $mainDocument->getElementById('container');
48    if ($container) {
49        // フラグメントの内容 (p1, p2) が container 要素の子ノードとして挿入されます。
50        // この操作の後、$fragment オブジェクトは空になります。
51        $container->appendChild($fragment);
52    }
53
54    echo "--- XPath で選択されたノードの childNodes の例 ---\n";
55    // 3. Dom\Document に対して Dom\XPath を使用してクエリを実行する
56    $xpath = new Dom\XPath($mainDocument);
57    
58    // XPath で特定の <p> 要素を選択するクエリです。
59    // 例: <div id="container"> の中にある2番目の <p> 要素を選択します。
60    // このクエリは、「This is the second paragraph with a <span>span element</span>.」という内容の <p> 要素を選択します。
61    $nodes = $xpath->query('//div[@id="container"]/p[2]');
62
63    if ($nodes->count() > 0) {
64        // XPath クエリの結果も Dom\NodeList です。
65        $targetNode = $nodes->item(0); // 選択された最初のノード (2番目の <p> 要素)
66        if ($targetNode instanceof Dom\Element) {
67            echo "XPathで選択されたノード: <" . $targetNode->tagName . "> (textContent: '" . $targetNode->textContent . "')\n";
68
69            // 4. 選択されたノード (上記XPathで取得した <p> 要素) の childNodes プロパティをアクセスする
70            // この <p> 要素の直接の子ノードは、テキストノード「This is the second paragraph with a 」、
71            // <span> 要素、そしてテキストノード「.」です。
72            echo "選択されたノードの直接の子ノード (Dom\\NodeList):\n";
73            foreach ($targetNode->childNodes as $child) {
74                if ($child instanceof Dom\Text) {
75                    // テキストノードは、余分な空白を除去して表示します。
76                    $trimmedText = trim($child->textContent);
77                    if ($trimmedText !== '') { // 空のテキストノードは表示をスキップ
78                        echo "  - テキストノード: '" . $trimmedText . "'\n";
79                    }
80                } elseif ($child instanceof Dom\Element) {
81                    echo "  - 要素ノード: <" . $child->tagName . "> (コンテンツ: '" . $child->textContent . "')\n";
82                }
83            }
84        }
85    } else {
86        echo "XPathクエリでノードが見つかりませんでした。\n";
87    }
88}
89
90// 関数の実行
91demonstrateDomDocumentFragmentChildNodesAndXPath();

このPHPコードは、ウェブページの構造をプログラムで操作するためのDOM（Document Object Model）の基本的な使い方を説明します。具体的には、Dom\DocumentFragmentクラス、そのchildNodesプロパティ、そしてXPathという検索言語の組み合わせを示しています。

Dom\DocumentFragmentは、実際のウェブページに直接影響を与えずに、一時的に複数のDOMノード（要素やテキストなど）をまとめておくための特別な入れ物です。このフラグメントにノードを追加してから、まとめて実際のページに挿入することで、効率的にDOMを操作できます。

childNodesプロパティは、このフラグメントや、他のDOM要素が直接持っている子ノード全てをリスト形式で取得するためのものです。このプロパティに引数は不要で、戻り値としてDOMNodeListというオブジェクトを返します。DOMNodeListは、取得した子ノードを一つずつ処理する際にforeach文で簡単にループして扱えます。

サンプルコードではまず、いくつかの段落（要素）や要素を作成し、Dom\DocumentFragmentに追加しています。その後、フラグメントのchildNodesプロパティを使って、追加されたノードがリストとして取得できることを示しています。

次に、このフラグメントの内容を実際のDom\Document（ウェブページ全体を表すオブジェクト）に挿入し、XPathを使って特定のノードを選択しています。XPathは、XMLやHTMLドキュメントの中から、指定した条件に合致するノードを強力なパターンマッチングで検索するための言語です。この例では、特定の<div>要素内にある2番目の要素をXPathで選び出し、その選択された要素に対してもchildNodesプロパティを使って、その内部にあるテキストノードや要素などの直接の子ノードを取得・表示しています。

このコードを通じて、PHPでウェブページの要素を生成、配置、そして特定の要素を効率的に検索し、その内部構造を調べる基本的な手法が学べます。

Dom\DocumentFragmentは一時的にノードをまとめるコンテナで、単独ではノードを作成できません。ノードの作成には別のDom\Documentが必要となる点にご注意ください。フラグメントの内容を実際のドキュメントへappendChildで追加すると、フラグメント内のノードは移動し、元のフラグメントは空になります。

childNodesプロパティは、対象ノードの直接の子ノード全てをDom\NodeListとして返します。これには要素ノードだけでなく、テキストノードや空白文字のみのノードも含まれるため、各ノードの種類をinstanceofで判別し、適切に処理を分けることが重要です。特にテキストノードは、trim()で余分な空白を除去すると扱いやすくなります。

XPathはDOMツリーから特定のノードを強力に選択する際に役立ち、その結果もDom\NodeListとなります。Dom\NodeListはforeachで簡単に反復処理が可能です。