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

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

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

基本的な使い方

lengthプロパティは、Dom\HTMLCollectionオブジェクトが保持するノードの数を表すプロパティです。Dom\HTMLCollectionは、HTMLドキュメント内の要素の集合を表すオブジェクトであり、例えばgetElementsByTagNameメソッドやgetElementsByClassNameメソッドなどのDOMメソッドの実行結果として取得できます。lengthプロパティを参照することで、コレクションに含まれる要素の総数を調べることができます。

lengthプロパティは読み取り専用であり、値を変更することはできません。コレクションの内容が変更された場合（要素が追加または削除された場合）、lengthプロパティの値は自動的に更新されます。

このプロパティは、コレクション内の要素をループ処理する際に特に役立ちます。例えば、forループを使用してコレクション内のすべての要素にアクセスし、特定の処理を実行する場合、lengthプロパティを使ってループの終了条件を制御できます。コレクションが空の場合、lengthプロパティの値は0になります。

lengthプロパティは整数値を返します。この値は常にコレクション内の要素の実際の数を反映します。Dom\HTMLCollectionオブジェクトの操作において、要素数を把握することは、効率的なDOM操作やデータ処理を行う上で不可欠です。lengthプロパティを適切に使用することで、HTMLドキュメント内の要素を動的に操作するプログラムをより効率的に記述できます。

構文(syntax)


1<?php
2
3$dom = new DOMDocument();
4$dom->loadHTML('<div><span></span></div>');
5$elements = $dom->getElementsByTagName('span');
6
7echo $elements->length;
8
9?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

このプロパティは、コレクションに含まれる要素の総数を整数で返します。

サンプルコード

PHPで文字列の長さを取得する


1<?php
2
3/**
4 * PHPで文字列の長さを正確に取得する方法を示すサンプルコードです。
5 * `Dom\HTMLCollection`の`length`プロパティがコレクション内の要素数を整数(int)で返すのと同様に、
6 * `mb_strlen`関数はマルチバイト文字を含む文字列の文字数を整数(int)で返します。
7 *
8 * @return void
9 */
10function getStringLengthExample(): void
11{
12    // 長さを取得したい文字列を定義します。
13    // 日本語のようなマルチバイト文字を含む文字列をテストします。
14    $multibyteString = "PHPプログラミング";
15    $englishString = "Hello World";
16    $emojiString = "👍 PHP 8";
17
18    // mb_strlen関数を使用して文字列の長さを取得します。
19    // 'UTF-8'エンコーディングを指定することで、マルチバイト文字を1文字として正確にカウントします。
20    $lengthMultibyte = mb_strlen($multibyteString, 'UTF-8');
21    $lengthEnglish = mb_strlen($englishString, 'UTF-8');
22    $lengthEmoji = mb_strlen($emojiString, 'UTF-8');
23
24    // 結果を出力します。
25    echo "文字列: '" . $multibyteString . "'\n";
26    echo "長さ (文字数): " . $lengthMultibyte . "文字\n\n";
27
28    echo "文字列: '" . $englishString . "'\n";
29    echo "長さ (文字数): " . $lengthEnglish . "文字\n\n";
30
31    echo "文字列: '" . $emojiString . "'\n";
32    echo "長さ (文字数): " . $lengthEmoji . "文字\n";
33}
34
35// 関数を実行してサンプルコードの動作を確認します。
36getStringLengthExample();

このサンプルコードは、PHPで文字列の長さを正確に取得する方法について、システムエンジニアを目指す初心者の方にも理解しやすいよう説明しています。

まず、リファレンス情報にあるDom\HTMLCollectionクラスのlengthプロパティは、HTML要素の集まり（コレクション）に含まれる要素の総数を整数（int）で返します。これと同様に、文字列の長さも文字数として整数で表現されます。

このサンプルコードでは、特に日本語や絵文字のようなマルチバイト文字を含む文字列の長さを正確に測るために、mb_strlen関数を使用しています。PHPの標準的なstrlen関数では、マルチバイト文字を正確に1文字としてカウントできない場合があるため、mb_strlen関数を用いることが推奨されます。

mb_strlen関数は、長さを調べたい文字列と、その文字列のエンコーディング（文字コード）を引数として受け取ります。サンプルコードでは'UTF-8'を指定しており、これにより日本語や絵文字なども正しく1文字としてカウントされます。そして、この関数は計算された文字列の文字数を整数（int）で戻り値として返します。

コード内では、「PHPプログラミング」といった日本語、「Hello World」のような英語、そして絵文字を含む文字列に対してmb_strlen関数を適用し、それぞれの正確な文字数を出力しています。これにより、PHPで文字列の長さを扱う際に、特にマルチバイト文字を正確にカウントするためにはmb_strlen関数が非常に有用であることが分かります。

PHPで文字列の長さを取得する際、初心者はstrlen()関数とmb_strlen()関数の違いに特に注意が必要です。strlen()は文字列のバイト数を数えるため、日本語のようなマルチバイト文字を含む場合は正確な文字数を返しません。対して、このサンプルコードで示されているmb_strlen()関数は、指定されたエンコーディングに基づいて文字数を正確にカウントします。安全に利用するためには、サンプルコードのようにmb_strlen()関数を使用し、Webアプリケーションで広く使われるUTF-8などの適切な文字エンコーディングを必ず指定してください。これにより、マルチバイト文字を含む文字列の文字数を正しく取得し、意図しない挙動や文字化けを防ぐことができます。

HTMLCollectionの要素数を取得する


1<?php
2
3// Dom\HTMLCollection の length プロパティのサンプルコード
4// HTMLCollection 内のノード数を取得する
5
6$dom = new DOMDocument();
7$dom->loadHTML('<!DOCTYPE html><html><body><h1>見出し</h1><p>段落1</p><p>段落2</p></body></html>');
8
9$paragraphs = $dom->getElementsByTagName('p');
10
11// HTMLCollection の長さを取得
12$length = $paragraphs->length;
13
14echo "段落の数: " . $length . PHP_EOL; // 出力: 段落の数: 2

PHPのDom\HTMLCollectionクラスにおけるlengthプロパティは、HTMLCollection内のノード数を取得するために使用されます。HTMLCollectionは、例えばgetElementsByTagName()メソッドなどによって返されるノードのリストです。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、HTML文字列をロードしています。次に、getElementsByTagName('p')メソッドを使用して、HTMLドキュメント内の全てのタグ（段落）をHTMLCollectionとして取得します。

$paragraphs->lengthとすることで、このHTMLCollectionに含まれる段落要素の数を取得できます。この例では、HTML内に2つのタグが存在するため、$length変数には2が格納されます。

lengthプロパティは引数を必要とせず、戻り値として整数（int）を返します。この整数は、HTMLCollectionが保持しているノードの数を表します。このように、lengthプロパティを利用することで、HTMLドキュメント内の特定の要素の数を簡単に把握することができます。これは、動的にHTMLを処理する際に非常に役立ちます。

Dom\HTMLCollectionのlengthプロパティは、コレクション内の要素数を取得する際に使用します。これは、PHPの標準関数であるstrlen()とは異なり、文字列の長さを測るものではない点に注意が必要です。Dom\HTMLCollectionは、DOMDocumentでHTMLを解析した結果得られるノードの集合を扱うためのオブジェクトです。lengthプロパティを利用する前に、getElementsByTagName()などのメソッドで、目的の要素が正しくコレクションに格納されているか確認しましょう。もし要素が見つからない場合、lengthは0を返します。Dom\HTMLCollectionはノードリストであり、配列のように要素にアクセスできますが、キーを指定してアクセスすることはできません。

PHP Dom\HTMLCollectionのlengthで要素数を取得する


1<?php
2
3// Dom\HTMLDocumentは、HTMLドキュメント全体を表現するクラスです。
4// これを使ってHTMLコンテンツをロードし、操作できます。
5$document = new Dom\HTMLDocument();
6
7// サンプルとなるHTMLコンテンツを定義します。
8$htmlContent = <<<HTML
9<!DOCTYPE html>
10<html>
11<head>
12    <title>PHP DOM Example</title>
13</head>
14<body>
15    <h1>DOM操作の基本</h1>
16    <p>これは最初のパラグラフです。</p>
17    <div>
18        <p>これはdiv内の2番目のパラグラフです。</p>
19        <span>これはspan要素です。</span>
20    </div>
21    <p>これは3番目のパラグラフです。</p>
22    <div>
23        <section>
24            <p>これはセクション内の4番目のパラグラフです。</p>
25        </section>
26    </div>
27</body>
28</html>
29HTML;
30
31// HTMLコンテンツをDom\HTMLDocumentにロードします。
32$document->loadHTML($htmlContent);
33
34// ドキュメント内のすべての 'p' (パラグラフ) タグ要素をDom\HTMLCollectionとして取得します。
35// Dom\HTMLCollectionは、取得されたDOM要素の読み取り専用リストを保持します。
36$paragraphs = $document->getElementsByTagName('p');
37
38// Dom\HTMLCollection::length プロパティを使用して、コレクション内の要素の数を取得します。
39// lengthプロパティは、コレクションに含まれる要素の総数を整数 (int) で返します。
40echo "ドキュメント内で見つかった <p> タグの数: " . $paragraphs->length . "個\n";
41
42// この例では、HTMLコンテンツに4つの <p> タグが含まれているため、出力は「4個」となります。
43
44?>

PHPのDom\HTMLCollection::lengthプロパティは、HTMLドキュメント内で特定の種類の要素がいくつ存在するかを数える際に使用する便利な機能です。このプロパティは、複数のHTML要素をまとめた読み取り専用のリストであるDom\HTMLCollectionオブジェクトに属しています。

サンプルコードでは、まずHTMLコンテンツをDom\HTMLDocumentにロードし、HTMLドキュメント全体を操作できるように準備しています。次に、$document->getElementsByTagName('p')を使って、ドキュメント内のすべての（パラグラフ）タグ要素を検索し、その結果を$paragraphsというDom\HTMLCollectionオブジェクトとして取得しています。

この$paragraphsオブジェクトに対してlengthプロパティを用いると、コレクションに含まれる要素の総数を簡単に取得できます。$paragraphs->lengthと記述するだけで、タグの数を整数（int）で得られます。このプロパティは引数を必要としません。コードの実行結果として「ドキュメント内で見つかった タグの数: 4個」と表示されるのは、サンプルHTMLコンテンツに4つのタグが含まれているためです。このように、lengthプロパティは、DOM要素の数を効率的に把握するために役立ちます。

「Dom\HTMLCollection::length」は、HTML要素のコレクションに含まれる要素の数を取得するための「プロパティ」であり、「メソッド」ではありません。そのため、$collection->length()ではなく$collection->lengthのように記述します。PHPの通常の配列の要素数を取得するcount()関数とは異なるため、混同しないよう注意が必要です。

このプロパティは、該当する要素が一つも見つからなかった場合でもエラーにはならず、0（ゼロ）を返します。これにより、処理を安全に継続できますので、戻り値を活用して条件分岐などを行うと良いでしょう。また、「length」プロパティは読み取り専用であり、コレクションの要素数を直接変更することはできません。