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

countメソッドの使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

countメソッドは、DOMNodeListオブジェクトが保持するノードの数を返すメソッドです。DOMNodeListは、ドキュメント内のノードのコレクションを表すオブジェクトで、通常はgetElementsByTagName()やquerySelectorAll()などのメソッドによって取得されます。

このcountメソッドを使用することで、DOMNodeListに含まれるノードの総数を容易に把握できます。これは、例えば、特定のタグを持つ要素の数を調べたり、条件に一致する要素がいくつ存在するかを確認したりする際に非常に役立ちます。

具体的には、$nodeList->count()のように記述することで、DOMNodeListオブジェクト $nodeList に含まれるノード数を整数値として取得できます。返される値は常に正の整数であり、ノードが一つも存在しない場合は0が返されます。

このメソッドは、DOMドキュメントを操作し、特定の要素を処理する際に、ループの制御や条件分岐の判断材料として利用されることが多いです。たとえば、特定の要素が存在する場合にのみ処理を実行したり、要素の数に基づいて異なる処理を行ったりする場合に便利です。

countメソッドは、DOMNodeListオブジェクトの状態を変化させることなく、単にノード数を返すだけであるため、副作用はありません。また、このメソッドは引数を取らないため、常に同じ方法で呼び出すことができます。DOM操作を行う上で、要素数を把握するための基本的なメソッドとして、システムエンジニアを目指す初心者にとっても重要なメソッドです。

構文(syntax)


1DOMNodeList::count(): int

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

DOMNodeListに格納されているノードの数を整数で返します。

サンプルコード

DOMNodeList::count()で要素数を取得する


1<?php
2
3// HTML文字列を定義します。これは解析対象のドキュメントとなります。
4$html = <<<HTML
5<!DOCTYPE html>
6<html>
7<head>
8    <title>DOMNodeList::count サンプル</title>
9</head>
10<body>
11    <h1>プログラミング言語</h1>
12    <ul>
13        <li>PHP</li>
14        <li>JavaScript</li>
15        <li>Python</li>
16    </ul>
17    <p>上記は人気のある言語です。</p>
18</body>
19</html>
20HTML;
21
22// DOMDocumentオブジェクトを作成します。これによりHTMLドキュメントを操作できます。
23$dom = new DOMDocument();
24
25// HTMLを読み込む際に発生する可能性のある警告を抑制します。
26// これは、HTMLが厳密なXML形式でない場合によく使われるテクニックです。
27libxml_use_internal_errors(true);
28$dom->loadHTML($html);
29libxml_clear_errors(); // 読み込み後にエラーバッファをクリアします。
30
31// DOMXPathオブジェクトを作成します。これはDOMドキュメントに対してXPathクエリを実行するために使用します。
32$xpath = new DOMXPath($dom);
33
34// XPathクエリ '//li' を使用して、ドキュメント内のすべての 'li' (リストアイテム) 要素を取得します。
35// query() メソッドの戻り値は DOMNodeList オブジェクトです。
36/** @var DOMNodeList $nodeList */
37$nodeList = $xpath->query('//li');
38
39// DOMNodeList::count() メソッドを使用して、取得した 'li' 要素の数を取得します。
40// このメソッドは、リストに含まれるノードの総数を整数で返します。
41$nodeCount = $nodeList->count();
42
43echo "取得した 'li' 要素の数 (DOMNodeList::count()を使用): " . $nodeCount . PHP_EOL;
44
45// PHP 8以降、DOMNodeList は Countable インターフェースを実装しています。
46// そのため、PHPの標準関数である count() を使用して要素数を取得することも可能です。
47// これはキーワード 'php countable' に関連する重要なポイントです。
48echo "取得した 'li' 要素の数 (PHPの count() 関数を使用): " . count($nodeList) . PHP_EOL;
49
50// DOMNodeList オブジェクトが Countable インターフェースを実装しているかを確認します。
51if ($nodeList instanceof Countable) {
52    echo "DOMNodeList オブジェクトは Countable インターフェースを実装しています。" . PHP_EOL;
53}
54
55?>

PHPのDOMNodeList::count()メソッドは、HTMLやXMLドキュメントから特定の条件で抽出された複数のノード（要素）のリスト、すなわちDOMNodeListオブジェクトに含まれる要素の総数を取得するために使用します。このメソッドは引数を必要とせず、リスト内のノードの数を整数値で返します。

例えば、提供されたサンプルコードでは、HTMLドキュメントからすべての<li>要素を抽出し、その結果をDOMNodeListオブジェクトとして取得しています。このDOMNodeListオブジェクトに対して$nodeList->count()と呼び出すことで、抽出された<li>要素がいくつあるかを簡単に確認できます。これは、ドキュメント内の特定の要素の存在数を数えたい場合に非常に便利です。

PHP 8以降のバージョンでは、DOMNodeListクラスがPHPの標準インターフェースであるCountableを実装しています。このため、DOMNodeList::count()メソッドを利用するだけでなく、PHPのグローバル関数であるcount()にDOMNodeListオブジェクトを渡しても、同様にリストの要素数を取得することが可能です。この変更により、DOMNodeListはPHPの他の数えられる（countable）オブジェクトと同じように扱えるようになり、より直感的で統一された方法で要素数を把握できるようになりました。

PHP 8以降、DOMNodeListオブジェクトはCountableインターフェースを実装しているため、要素数を取得する際にDOMNodeList::count()メソッドと、PHP標準のcount()関数の両方を使用できます。どちらを使っても同じ結果が得られますが、開発中のプロジェクトのコーディング規約や慣習に合わせて選択すると良いでしょう。HTMLを解析する際、libxml_use_internal_errors(true)で発生する可能性のある警告を抑制し、libxml_clear_errors()でクリアする処理は、厳密でないHTMLを安全に扱うための一般的な手法です。この処理を理解することで、予期せぬエラーを防ぎながらドキュメントを読み込めます。

PHP DOMNodeList count() で要素数を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMNodeList::count() メソッドの使用例を示します。
7 * HTMLドキュメントから特定のタグを持つ要素を取得し、その数を数えます。
8 */
9function showDomNodeListCountExample(): void
10{
11    // 解析するサンプルHTMLコンテンツ
12    $html = <<<HTML
13    <!DOCTYPE html>
14    <html lang="ja">
15    <head>
16        <title>サンプルページ</title>
17    </head>
18    <body>
19        <h1>商品リスト</h1>
20        <ul>
21            <li>りんご</li>
22            <li>みかん</li>
23            <li>ぶどう</li>
24        </ul>
25    </body>
26    </html>
27    HTML;
28
29    // DOMDocumentオブジェクトを生成
30    $dom = new DOMDocument();
31
32    // HTMLのパース時に発生する警告を抑制し、内部で処理する
33    libxml_use_internal_errors(true);
34    $dom->loadHTML($html);
35    libxml_clear_errors();
36
37    // getElementsByTagName() を使って、すべての <li> 要素を取得します。
38    // このメソッドは、見つかった要素を含む DOMNodeList オブジェクトを返します。
39    $listItems = $dom->getElementsByTagName('li');
40
41    // DOMNodeList::count() メソッドを呼び出し、リスト内のノード数を取得します。
42    // この例では <li> 要素の数、つまり 3 が返されます。
43    $itemCount = $listItems->count();
44
45    // 結果を出力します。
46    echo "リストアイテムの数: " . $itemCount . PHP_EOL;
47}
48
49// 関数を実行してサンプルを表示
50showDomNodeListCountExample();

このサンプルコードは、PHPでHTMLドキュメントを操作する際に使用するDOMNodeListオブジェクトのcount()メソッドの具体的な使い方を示しています。DOMNodeList::count()は、特定の条件で取得したHTML要素のリストに含まれる要素の数を数えるために利用されるメソッドです。

まず、サンプルコードではHTML文字列をDOMDocumentクラスで解析し、その内容を操作可能な形式に変換しています。次に、getElementsByTagName('li')メソッドを使って、ドキュメント内のすべての<li>タグを持つ要素を検索し、それらをDOMNodeListという形式のオブジェクトとして取得しています。このDOMNodeListは、見つかった複数のHTML要素をまとめて扱えるリストのようなものです。

その後、取得した$listItems（DOMNodeListオブジェクト）に対して->count()メソッドを呼び出しています。このcount()メソッドは引数を一切必要とせず、DOMNodeList内に格納されている要素の総数を整数値（int型）として返します。この例では、サンプルHTML内に<li>要素が3つ存在するため、count()メソッドは「3」という値を返します。

このように、DOMNodeList::count()メソッドを使うことで、HTMLコンテンツから特定の要素を抽出し、その数を手軽に確認することができます。これはWebページから情報を抽出したり、HTMLの構造を解析したりする際に非常に便利な機能です。

DOMNodeList::count()は、特定のDOM要素リストの数を取得するメソッドです。PHPには同名の組み込み関数count()がありますが、こちらは$オブジェクト->count()のようにインスタンスに対して呼び出すメソッドである点にご注意ください。初心者の方は、関数とメソッドの呼び出し方の違いをよく理解してください。

HTMLを解析する際は、libxml_use_internal_errors(true)とlibxml_clear_errors()をセットで使用し、HTMLの構文エラーや警告を適切に処理することが重要です。これにより、予期せぬ警告出力などを防ぎ、安全なコードを維持できます。

このメソッドは引数を取らず、常にリスト内の要素数を整数で返します。対象要素が見つからない場合は0を返しますので、戻り値の意味を理解して利用してください。