【PHP8.x】DOMDocument::childElementCountプロパティの使い方
childElementCountプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
childElementCountプロパティは、DOMDocumentクラスに属し、指定されたノードの直接の子である要素ノードの数を保持するプロパティです。
このプロパティは、XMLやHTMLといったドキュメントの構造を表現するDOM（Document Object Model）において、ある親ノードの直下にある子要素ノードの数を効率的に取得するために使用されます。ここでいう「要素ノード」とは、例えばHTMLの<div>や<span>のようなタグ、あるいはXMLにおけるユーザーが定義したタグのように、ドキュメントの構造を構成する主要な部分を指します。
childElementCountプロパティの重要な特徴は、テキストノード（要素間の空白や文字データ）、コメントノード（<!-- ... -->）、処理命令ノードなどをカウントに含めない点です。これにより、純粋に子要素の数だけを正確に把握することができ、例えばWebページ内の特定のセクションにいくつの子要素（画像やリンクなど）が含まれているかを調べたい場合に非常に役立ちます。
PHP 8以降のバージョンでは、DOMDocumentクラスがDOMParentNodeインターフェースを実装したことにより、このchildElementCountプロパティが利用できるようになりました。これにより、ドキュメント全体のルートノードであるDOMDocumentオブジェクトに対しても、その直下にある要素の数を簡単に取得できるようになり、DOMツリーの操作がより直感的になります。このプロパティは常に0以上の整数を返し、子要素が存在しない場合は0を返します。
構文(syntax)
1<?php 2$dom = new DOMDocument(); 3$dom->loadHTML('<html><body><h1>見出し</h1><p>段落</p></body></html>'); 4 5// DOMDocumentオブジェクトのdocumentElementプロパティを通じて、 6// HTML文書のルート要素（<html>）直下の子要素の数を取得します。 7// この例では、<html>要素の子要素は<body>要素のみなので、結果は1です。 8echo $dom->documentElement->childElementCount;
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
DOMDocument オブジェクトに直接紐づけられている子要素の数を整数で返します。
サンプルコード
PHP DOM: childElementCount で子要素数を数える
1<?php 2 3/** 4 * DOMDocument::childElementCount プロパティの使用例をデモンストレーションします。 5 * 6 * この関数は、HTML文字列をDOMDocumentオブジェクトとしてロードし、 7 * ドキュメントの直接の子要素数、およびルート要素の直接の子要素数を取得します。 8 * キーワード「count++」に関連付けて、取得した子要素数を使ってループ処理を行う例も示します。 9 * 10 * @return void 11 */ 12function demonstrateDomChildElementCount(): void 13{ 14 // HTML文字列を準備します。 15 // DOMDocument::childElementCount は要素ノードのみをカウントします。 16 // 通常、DOMDocumentオブジェクト自体の直接の子要素はルート要素が1つだけです。 17 // ルート要素 (<html>) の直接の子要素は <head> と <body> です。 18 $htmlString = <<<HTML 19<!DOCTYPE html> 20<html> 21 <head> 22 <title>サンプルページ</title> 23 </head> 24 <body> 25 <h1>PHP DOM サンプル</h1> 26 <p>これは段落1です。</p> 27 <p>これは段落2です。</p> 28 <!-- これはコメントなのでカウントされません --> 29 </body> 30</html> 31HTML; 32 33 // DOMDocumentオブジェクトを初期化します。 34 $dom = new DOMDocument(); 35 36 // HTML文字列をDOMDocumentにロードします。 37 // @ を使用して、HTML5形式でないDOCTYPEなどに関する潜在的な警告を抑制しています。 38 // 実際のアプリケーションでは、エラーハンドリングを適切に行うことが推奨されます。 39 @$dom->loadHTML($htmlString); 40 41 echo "--- DOMDocument::childElementCount の基本的な使用法 ---\n"; 42 43 // DOMDocumentオブジェクト自身の直接の子要素数を取得します。 44 // この場合、HTMLドキュメントの直接の子要素は通常ルート要素 (<html>) のみなので「1」になります。 45 // childElementCountは要素ノードのみをカウントするため、DOCTYPE宣言やコメントは含まれません。 46 $docChildCount = $dom->childElementCount; 47 echo "DOMDocumentオブジェクトの直接の子要素数: " . $docChildCount . " (ルート要素 <html> のみ)\n"; 48 49 // ドキュメントのルート要素 (<html>) を取得します。 50 $documentElement = $dom->documentElement; 51 52 if ($documentElement instanceof DOMElement) { 53 // ルート要素 (<html>) の直接の子要素数を取得します。 54 // このHTMLの場合、<head> と <body> の2つの要素がカウントされます。 55 $rootChildCount = $documentElement->childElementCount; 56 echo "ルート要素 (html) の直接の子要素数: " . $rootChildCount . " (<head> と <body>)\n"; 57 58 echo "\n--- キーワード 'count++' の関連付け ---\n"; 59 echo "取得したルート要素の子要素数 (" . $rootChildCount . ") を利用してループ処理を行います。\n"; 60 61 $loopCounter = 0; // ループのカウンタを初期化 62 63 // 子要素数分だけループを回し、カウンタをインクリメントします。 64 // これは「数える」という概念と「++（インクリメント）」を結びつける一例です。 65 if ($rootChildCount > 0) { 66 echo "子要素数 " . $rootChildCount . " 回のループを開始します。\n"; 67 for ($i = 0; $i < $rootChildCount; $i++) { 68 $loopCounter++; // カウンタをインクリメント (count++) 69 echo " 現在のループ回数: " . $loopCounter . "\n"; 70 } 71 } else { 72 echo "子要素がないため、ループは実行されません。\n"; 73 } 74 echo "最終的なループカウンタの値: " . $loopCounter . "\n"; 75 76 } else { 77 echo "エラー: DOMDocumentにルート要素が見つかりませんでした。\n"; 78 } 79} 80 81// 関数を実行してデモンストレーションを開始します。 82demonstrateDomChildElementCount(); 83
PHP 8のDOMDocument::childElementCountプロパティは、HTMLやXMLドキュメントの構造を扱うDOMDocumentオブジェクト、またはその子要素であるDOMElementオブジェクトに所属します。このプロパティは引数を取らず、指定されたノードが持つ直接の子要素ノードの数を整数値（int）で返します。ここで言う「子要素ノード」とは、タグで囲まれたHTML要素のようなノードのみを指し、コメントやテキストノードはカウントされません。
サンプルコードでは、まずHTML文字列をDOMDocumentオブジェクトとしてロードしています。$dom->childElementCountでは、DOMDocumentオブジェクトの直接の子要素であるルート要素（<html>）が1つカウントされます。次に、ルート要素である<html>を取得し、そのchildElementCountプロパティを参照しています。この例では、<html>の直接の子要素である<head>と<body>の2つの要素がカウントされます。このように、このプロパティは特定の親要素が持つ直接の子要素の数を簡単に取得する際に非常に便利です。
さらに、取得したルート要素の子要素数（この場合2）を利用し、キーワード「count++」に関連付けて、その回数分だけループ処理を実行し、カウンターをインクリメントする例が示されています。これにより、動的に取得した要素数に基づいて繰り返し処理を構築する方法が理解できます。
DOMDocument::childElementCountプロパティは、要素ノードのみをカウントし、コメントやDOCTYPE宣言は数えません。DOMDocumentオブジェクト自体の直接の子要素は、通常、ルート要素一つですので、子要素の数を数える際はどのDOM要素に対してプロパティを使用しているか注意が必要です。サンプルコードの@によるエラー抑制は開発やデバッグ用途で、実運用ではloadHTML()の戻り値を確認したり、try-catchを用いたりして適切なエラーハンドリングを行い、安全性を確保してください。また、ルート要素が確実に取得できるか、またはそれがDOMElement型であるかを$dom->documentElement instanceof DOMElementで確認してから操作する習慣をつけましょう。キーワードのcount++は、取得した子要素数に基づくループ処理の一般的な例として理解してください。
PHP DOMDocument::childElementCount で要素数を取得する
1<?php 2 3// DOMDocument::childElementCount の使用例 4// このプロパティは、PHP 8 以降で利用可能です。 5// DOMDocument オブジェクトの直接の子要素（DOMElement型のみ）の数を返します。 6// 通常のHTMLドキュメントでは、<!DOCTYPE html> の後に <html> タグが一つだけ存在するため、 7// このプロパティの値は '1' となることがほとんどです。 8 9// HTML ドキュメントの文字列を定義 10// ここでは、標準的なHTML構造を持つドキュメントを想定します。 11$htmlContent = <<<HTML 12<!DOCTYPE html> 13<html> 14<head> 15 <title>PHP DOMDocument::childElementCount サンプル</title> 16</head> 17<body> 18 <h1>DOMDocument::childElementCount の解説</h1> 19 <p>このページは、<code>DOMDocument::childElementCount</code> プロパティの動作を示すためのサンプルです。</p> 20 <!-- このコメントは要素としてカウントされません --> 21 <div> 22 <span>子要素の中の子要素</span> 23 </div> 24</body> 25</html> 26HTML; 27 28// 新しい DOMDocument オブジェクトを作成 29$dom = new DOMDocument(); 30 31// HTML 文字列をロードします。 32// loadHTML() は、HTMLの構文解析を行い、DOMツリーを構築します。 33$dom->loadHTML($htmlContent); 34 35// DOMDocument オブジェクトの childElementCount プロパティにアクセスします。 36// これは、ドキュメントの直下にある要素（このHTMLでは <html> タグ）の数を返します。 37$elementCount = $dom->childElementCount; 38 39echo "DOMDocument の直接の子要素（DOMElement型のみ）の数: " . $elementCount . "\n"; 40 41// 参考: DOMDocument のすべての直接の子ノード（DOMElement以外も含む）の数を取得する場合 42// DOMDocument::childNodes->length は、DOCTYPEノードやHTML要素ノードなど、 43// すべての種類のノード（要素、テキスト、コメント、処理命令、DOCTYPEなど）をカウントします。 44$totalNodes = $dom->childNodes->length; 45echo "DOMDocument の直接の全ノード（DOCTYPEや要素など）の数: " . $totalNodes . "\n"; 46 47// この例では、`childElementCount` は `<html>` 要素のみをカウントするため `1` を返します。 48// 一方、`childNodes->length` は `<!DOCTYPE html>` と `<html>` 要素の両方をカウントするため `2` を返します。 49 50?>
PHPのDOMDocumentクラスは、HTMLやXMLドキュメントをオブジェクトとして扱い、その内容を操作するための機能を提供します。DOMDocument::childElementCountは、PHP 8以降で利用可能なプロパティの一つで、このDOMDocumentオブジェクトの「直接の子要素」の数を整数（int）で返します。
ここで言う「直接の子要素」とは、DOMElement型、つまり<html>や<head>、<body>といったHTMLタグに相当するノードのみを指します。コメントやテキストノード、<!DOCTYPE html>のような宣言は要素としてカウントされません。このプロパティは引数を取りません。
サンプルコードでは、まずHTML文字列をDOMDocumentオブジェクトにロードし、DOMツリーを構築しています。標準的なHTMLドキュメントでは、DOMDocumentオブジェクトの直下には通常、<html>タグが一つだけ存在します。そのため、$dom->childElementCountの値は1となります。これは、PHPの配列やオブジェクトの要素数を数える一般的なcount()関数とは異なり、DOMツリーの特定の階層における要素ノードの数を取得するものです。
比較として示されている$dom->childNodes->lengthは、DOMDocumentの直接の子ノード全て（例えば、<!DOCTYPE html>宣言や<html>要素など）を数えるため、この例では2を返します。このように、childElementCountは、特定の種類のノードに限定して数を取得したい場合に非常に便利です。
このプロパティはPHP 8以降で利用可能であり、それ以前のバージョンでは動作しないため注意が必要です。DOMDocument::childElementCountは、DOMDocumentオブジェクトの直下にある「HTML要素タグ（DOMElement型）」のみを数えます。具体的には<!DOCTYPE html>のようなDOCTYPE宣言や、コメントノード、テキストノードはカウントされません。標準的なHTMLドキュメントでは、DOMDocumentの直接の子要素は<html>タグ一つだけとなるため、このプロパティの値は通常「1」となります。
すべての種類の直接の子ノード（要素、DOCTYPE、コメント、テキストなど）の数を取得したい場合は、$dom->childNodes->lengthを使用する必要があります。それぞれの用途を理解し、正しく使い分けることが重要です。