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

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

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

基本的な使い方

itemメソッドは、Dom\HTMLCollectionオブジェクト内の指定されたインデックスに対応するノードを返すメソッドです。Dom\HTMLCollectionは、HTMLドキュメント内の要素のコレクション（例えば、同じタグ名を持つ要素のリスト）を表します。このメソッドを使用することで、コレクション内の特定の要素にアクセスできます。

具体的には、item(int $index): ?DOMNodeという形式で定義されており、整数型の引数 $index を受け取ります。この $index は、コレクション内の要素の位置を示す0から始まるインデックスです。

メソッドの戻り値は、DOMNode型、またはnullです。DOMNodeは、DOM（Document Object Model）におけるノードを表す一般的なクラスで、要素、テキスト、属性など、ドキュメント内のあらゆる構成要素の基底クラスとなります。指定された $index がコレクションの範囲内の場合、itemメソッドはそのインデックスに対応するDOMNodeオブジェクトを返します。

もし $index がコレクションの範囲外（例えば、コレクションのサイズよりも大きい場合や負の値の場合）である場合、itemメソッドはnullを返します。これは、指定されたインデックスに対応する要素が存在しないことを意味します。

このメソッドは、Dom\HTMLCollection内の要素を順番に処理したり、特定の条件に基づいて要素を選択したりする際に非常に役立ちます。例えば、特定のタグ名の要素が複数存在する場合に、itemメソッドを使用して各要素に個別にアクセスし、その属性や内容を調べることができます。foreachループなどと組み合わせて使うことで、コレクション内のすべての要素に対して処理を行うことも容易になります。

構文(syntax)


1public Dom\Node? Dom\HTMLCollection::item(int $index)

引数(parameters)

int $index

int $index: 取得したい要素のインデックス（0から始まる整数）を指定します

戻り値(return)

?Dom\Element

引数として指定されたインデックス番号に対応する Dom\Element オブジェクト、または要素が存在しない場合は null を返します。

サンプルコード

PHPでHTML要素をIDで取得する


1<?php
2
3// HTML から特定の ID を持つ要素を取得する関数
4function getItemById(string $html, string $itemId): ?DOMElement
5{
6    $dom = new DOMDocument();
7    @$dom->loadHTML($html); // エラー抑制演算子を使用
8
9    $element = $dom->getElementById($itemId);
10
11    return $element;
12}
13
14// HTML サンプル
15$html = <<<HTML
16<!DOCTYPE html>
17<html>
18<head>
19    <title>サンプル</title>
20</head>
21<body>
22    <div id="container">
23        <p id="item_id">これはアイテムです。</p>
24    </div>
25</body>
26</html>
27HTML;
28
29// item_id を持つ要素を取得
30$item = getItemById($html, 'item_id');
31
32// 結果を出力
33if ($item) {
34    echo "要素が見つかりました: " . $item->nodeValue . "\n";
35} else {
36    echo "要素が見つかりませんでした。\n";
37}

このサンプルコードは、PHPのDOMDocumentクラスとgetElementByIdメソッドを使って、HTML文字列から特定のIDを持つ要素を取得する方法を示しています。getItemById関数は、HTML文字列と探したい要素のIDを引数として受け取ります。まず、DOMDocumentオブジェクトを生成し、loadHTMLメソッドでHTML文字列を読み込みます。@演算子は、HTMLの解析中に発生する可能性のあるエラーを抑制するために使用されています。

次に、getElementByIdメソッドを使用して、指定されたIDを持つ要素をDOMツリーから検索します。このメソッドは、IDに一致する最初の要素をDOMElementオブジェクトとして返します。一致する要素が見つからない場合は、nullを返します。

getItemById関数は、見つかったDOMElementオブジェクトまたはnullを返します。サンプルコードでは、HTML文字列内でIDがitem_idの要素を検索し、見つかった場合はその要素のテキスト内容（nodeValue）を出力します。要素が見つからなかった場合は、その旨を示すメッセージを出力します。

この例では、Dom\HTMLCollectionクラスのitemメソッドは直接使用されていませんが、getElementByIdメソッドの結果として返されるDOMElementオブジェクトを操作することで、HTML要素の内容を取得したり、属性を変更したりできます。Dom\HTMLCollectionのitemメソッドは、一般的には、複数の要素を含むコレクションから特定のインデックスの要素を取得するために使用されます。ここでは、IDで直接要素を取得しているため、itemメソッドの利用は省略されています。

DOMDocument::loadHTMLでHTMLを読み込む際、エラーが発生しても処理が止まらないように@エラー抑制演算子を使用しています。しかし、これは根本的な問題解決を隠蔽する可能性があるため、デバッグ時には削除してエラー内容を確認することを推奨します。DOMDocument::getElementByIdは、HTMLが正しく構造化されていない場合や、同じIDが複数存在する場合に、期待通りの要素を取得できないことがあります。IDはHTMLドキュメント内で一意である必要があります。Dom\HTMLCollection::itemメソッドを使う場合は、$indexがコレクションの範囲内にあることを確認してください。範囲外のインデックスを指定すると、予期せぬエラーが発生する可能性があります。このサンプルコードではitem_idで直接要素を取得しているため、Dom\HTMLCollection::itemメソッドは使用していません。

PHP Dom\HTMLCollection::item で要素を取得する


1<?php
2
3// HTMLドキュメントをロードする
4$dom = new DOMDocument();
5$dom->loadHTML('<html><body><ul><li>Item 1</li><li>Item 2</li><li>Item 3</li></ul></body></html>');
6
7// ul要素を取得する
8$ul = $dom->getElementsByTagName('ul')->item(0);
9
10// li要素のコレクションを取得する
11$li_elements = $ul->getElementsByTagName('li');
12
13// コレクションから特定のインデックスの要素を取得する
14$second_item = $li_elements->item(1); // indexは0から始まるため、2番目の要素を取得
15
16// 取得した要素が存在するか確認し、内容を表示する
17if ($second_item !== null) {
18    echo $second_item->textContent . PHP_EOL; // Output: Item 2
19} else {
20    echo "指定されたインデックスの要素は見つかりませんでした。" . PHP_EOL;
21}
22
23?>

このサンプルコードは、PHPのDOM拡張を用いて、HTMLドキュメントから特定の要素をDom\HTMLCollection::item()メソッドで取得する方法を示しています。

まず、DOMDocumentクラスのインスタンスを作成し、loadHTML()メソッドでHTMLドキュメントを読み込みます。次に、getElementsByTagName()メソッドでul要素を取得し、その最初の要素をitem(0)で取得しています。ここで、item()メソッドは、Dom\HTMLCollectionオブジェクトから、指定されたインデックスに対応するDom\Elementオブジェクトを返します。インデックスは0から始まることに注意してください。

続いて、取得したul要素に対して、再度getElementsByTagName('li')を実行し、li要素のコレクションを取得します。このコレクションから、item(1)メソッドを使って、2番目のli要素を取得しています。

item()メソッドは、指定されたインデックスに対応する要素が存在しない場合、nullを返します。そのため、サンプルコードでは、取得した要素がnullでないかを確認し、存在する場合のみ、その要素のテキスト内容（textContentプロパティ）を出力しています。存在しない場合は、エラーメッセージを表示します。

Dom\HTMLCollection::item()メソッドは、HTMLドキュメント内の要素を効率的に操作するための重要なツールです。引数$indexには、取得したい要素のインデックス（整数）を指定します。戻り値は、指定されたインデックスのDom\Elementオブジェクト、または、インデックスが存在しない場合はnullを返します。

Dom\HTMLCollection::item() メソッドの利用に関する注意点です。このメソッドは、Dom\HTMLCollection オブジェクトから指定されたインデックスの要素を返します。

注意点として、インデックスは0から始まる点に注意してください。サンプルコードのように、2番目の要素を取得する場合は、item(1) と指定する必要があります。

また、指定したインデックスが存在しない場合、item() メソッドは null を返します。サンプルコードのように、戻り値が null かどうかを確認することで、存在しない要素へのアクセスを防ぎ、エラーを回避できます。null チェックを怠ると、存在しないオブジェクトのメソッドを呼び出そうとしてエラーが発生する可能性があります。