【PHP8.x】Dom\Document::childElementCountプロパティの使い方

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

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

基本的な使い方

childElementCountプロパティは、Dom\Documentオブジェクトが直接の子として持つ要素ノード（Elementノード）の数を整数値で保持するプロパティです。このプロパティは、Document Object Model (DOM) において、ドキュメントの直下に存在する要素の数を正確に把握したい場合に利用されます。

DOMツリー構造では、ドキュメントのノードは親子関係を持っていますが、その中には要素ノードだけでなく、テキストノードやコメントノードなど、様々な種類のノードが含まれています。childElementCountプロパティの特長は、これらの多種多様なノードの中から、純粋な「要素」に限定してその数を数える点にあります。したがって、テキストコンテンツやコメント、処理命令といった非要素ノードはカウントに含まれません。

システムエンジニアを目指す初心者の方にとって、ウェブページやXMLドキュメントの構造をPHPでプログラム的に解析する際に、このプロパティは大変有用です。例えば、ドキュメントの最上位レベルにいくつの主要な要素が存在するかを知りたい場合や、DOMツリーを走査する際に、現在注目しているノードの子要素の有無や数を素早く確認したい場合に、このchildElementCountプロパティから値を取得するだけで簡単に情報を得ることができます。これにより、DOM構造の理解が深まり、より効率的な処理を記述できるようになります。

構文(syntax)


1<?php
2
3$dom = new Dom\Document();
4$element = $dom->createElement('html');
5$dom->appendChild($element);
6
7$childElementCount = $dom->childElementCount;
8
9echo $childElementCount;

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

このプロパティは、DOM要素の直下にある子要素の数を整数（int）で返します。

サンプルコード

PHP Dom\Document childElementCountで要素数を数える


1<?php
2
3/**
4 * Dom\Document::childElementCount プロパティの使用例を示します。
5 * このプロパティは、ドキュメントの直下にある要素ノードの数を返します。
6 * 通常のHTMLドキュメントでは、ルート要素である <html> が唯一の直下の子要素であるため、
7 * この値は 1 となります。
8 */
9function demonstrateChildElementCount(): void
10{
11    // 新しいDom\Documentオブジェクトを作成します。
12    $document = new Dom\Document();
13
14    // サンプルとなるHTML文字列をロードします。
15    // <!DOCTYPE html> は要素ノードとしてカウントされません。
16    // <html> がドキュメントの最初の（そして通常唯一の）要素ノードとなります。
17    $htmlContent = '
18        <!DOCTYPE html>
19        <html>
20        <head>
21            <title>My Page</title>
22        </head>
23        <body>
24            <h1>Welcome</h1>
25            <p>This is a sample paragraph.</p>
26        </body>
27        </html>
28    ';
29    $document->loadHTML($htmlContent);
30
31    // Dom\Document::childElementCount プロパティを使用して、
32    // ドキュメント直下の子要素ノードの数を取得します。
33    // この場合、通常は <html> 要素が1つなので、結果は 1 になります。
34    $elementCount = $document->childElementCount;
35
36    // 取得した数を表示します。
37    echo "ドキュメント直下の子要素ノードの数: " . $elementCount . "\n";
38}
39
40// 関数を実行して、Dom\Document::childElementCount の動作を確認します。
41demonstrateChildElementCount();

PHP 8で導入されたDom\Document::childElementCountプロパティは、XMLやHTMLドキュメントの構造を扱う際に非常に便利です。このプロパティは、指定されたドキュメントオブジェクトの直下にある「子要素ノード」の総数を取得するために使用されます。

このプロパティは引数を一切必要とせず、ドキュメントにロードされたHTMLやXMLの内容に基づき、直下の子要素の数を整数（int）として返します。例えば、Webページでよく使われるHTMLドキュメントの場合、通常はルート要素である<html>タグがドキュメント直下の唯一の子要素ノードとなります。

サンプルコードでは、まず新しいDom\Documentオブジェクトを作成し、典型的なHTML文字列をloadHTML()メソッドで読み込んでいます。ここで注意すべきは、<!DOCTYPE html>のような宣言は要素ノードとは見なされず、childElementCountのカウント対象には含まれない点です。そのため、ロードされたHTMLにおいて、ドキュメント直下には<html>要素のみが存在することになります。

その後、$documentオブジェクトから$document->childElementCountとしてプロパティにアクセスすることで、直下の子要素ノードの数が取得され、$elementCount変数に格納されます。このHTML構造では、<html>が一つであるため、結果として「1」という値が表示されます。このように、このプロパティを使えば、ドキュメントの最上位の構造がどのように構成されているかを簡単に確認することができます。

Dom\Document::childElementCountプロパティは、ドキュメントの直下にある要素ノードの数を返します。初心者が間違いやすい点として、これはドキュメント内の全ての子孫要素の数を数えるものではなく、あくまでルート要素（通常のHTMLでは<html>タグ）のように、直接の子要素のみを対象としていることに注意が必要です。

そのため、一般的なHTMLドキュメントをロードした場合、このプロパティは通常「1」を返します。<!DOCTYPE html>のような宣言や、空白文字、コメントノードは要素ノードとしてカウントされません。特定の要素の子要素数を調べたい場合は、その要素オブジェクトのchildElementCountプロパティを利用してください。この理解が、DOM操作を正しく行う上で非常に重要となります。

PHP Dom\Document::childElementCount で要素数を取得する


1<?php
2
3// Dom\Document クラスを使用するために、use宣言を行います。
4use Dom\Document;
5
6/**
7 * 指定されたHTML文字列をパースし、そのドキュメントの直下にある要素の数を返します。
8 * Dom\Document::childElementCount プロパティの基本的な使い方を示します。
9 *
10 * PHPの標準的な `count()` 関数は、配列や `Countable` インターフェースを実装したオブジェクトの要素数を数えます。
11 * 一方、`Dom\Document::childElementCount` は、XML/HTMLドキュメントのDOMノード（この場合はドキュメント自体）の
12 * 直下の子要素（HTMLタグ）の数を数えるための専用のプロパティです。
13 *
14 * @param string $html HTML形式の文字列
15 * @return int ドキュメントの直下の子要素の数。
16 *             健全なHTMLドキュメントの場合、通常はルート要素である `<html>` タグ一つなので1を返します。
17 */
18function getDocumentRootChildElementCount(string $html): int
19{
20    // 新しい Dom\Document オブジェクトを作成します。
21    // このオブジェクトはHTMLやXMLドキュメントをメモリ上で表現し、DOMツリーを構築します。
22    $document = new Document();
23
24    // 指定されたHTML文字列をDOMオブジェクトにロードします。
25    // これにより、HTMLの構造が解析され、DOMツリーがメモリ上に構築されます。
26    // 不正なHTMLの場合やその他の問題でエラーが発生した際は、Dom\DOMException がスローされる可能性があります。
27    // この例では簡潔さのためエラーハンドリングは省略していますが、実運用では考慮すべき点です。
28    $document->loadHTML($html);
29
30    // Dom\Document::childElementCount プロパティを使用して、
31    // ドキュメントオブジェクトの直下にある子要素の数を取得します。
32    // HTMLドキュメントの場合、ドキュメントの直下にある唯一の要素は通常 `<html>` タグです。
33    // したがって、このプロパティが返す値は、ほとんどの健全なHTMLドキュメントでは「1」になります。
34    return $document->childElementCount;
35}
36
37// サンプルとして使用するHTML文字列を定義します。
38$sampleHtml = <<<HTML
39<!DOCTYPE html>
40<html>
41<head>
42    <title>PHP Dom\Document::childElementCount サンプル</title>
43</head>
44<body>
45    <h1>ようこそ！</h1>
46    <p>これはDom\Document::childElementCount のデモです。</p>
47    <div>
48        <span>内部要素</span>
49    </div>
50</body>
51</html>
52HTML;
53
54// 関数を呼び出して、HTMLドキュメントの直下の子要素の数を取得します。
55$rootChildElements = getDocumentRootChildElementCount($sampleHtml);
56
57// 結果を出力します。
58// 上記のサンプルHTMLでは、ドキュメントの直下には `<html>` タグが一つだけ存在するため、結果は「1」になります。
59echo "HTMLドキュメントの直下の子要素の数: " . $rootChildElements . "\n";

Dom\Document::childElementCountは、PHPが提供するDom\Documentクラスのプロパティで、HTMLやXMLドキュメントの直下にある子要素の数を取得するために使用します。このプロパティは引数を取らず、戻り値として整数（int）を返します。

PHPには、配列などの要素数を数える標準のcount()関数がありますが、Dom\Document::childElementCountはそれとは異なり、XMLやHTMLのDOM（Document Object Model）ツリー構造に特化しています。具体的には、ドキュメントオブジェクトそのものの直下にあるHTMLタグ（要素ノード）の数を数えるための専用機能です。

サンプルコードでは、まずDom\Documentオブジェクトを新しく作成し、loadHTML()メソッドを使って与えられたHTML文字列を解析し、DOMツリーを構築しています。その後、作成された$documentオブジェクトのchildElementCountプロパティにアクセスすることで、ドキュメント直下の子要素の数を取得しています。

通常の健全なHTMLドキュメントの場合、ドキュメントの直下にある最上位の要素は<html>タグ一つだけです。そのため、このプロパティはほとんどの場合「1」を返します。このプロパティを使うことで、HTMLやXMLの構造をプログラムで分析する際に、ルートレベルの要素数を簡単に確認することができます。

このサンプルコードは、HTMLドキュメントのDOM構造における直下の子要素の数を取得するDom\Document::childElementCountプロパティの使い方を示しています。PHP標準のcount()関数とは異なり、childElementCountはDOMノードの直下の子要素（HTMLタグなど）のみを数える専門の機能です。特に、健全なHTMLドキュメントでは、ドキュメントの直下には通常<html>タグが一つだけ存在するため、このプロパティは「1」を返します。これはドキュメント全体のタグ数ではないことにご注意ください。また、Dom\Document::loadHTML()で不正なHTML文字列をパースしようとすると、Dom\DOMExceptionが発生する可能性があります。実運用では、エラーが発生しないよう、適切なエラーハンドリングの実装を検討してください。