【PHP8.x】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

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

サンプルコード

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ドキュメント内の全ての<p>タグ（段落）をHTMLCollectionとして取得します。

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

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

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