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

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

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

基本的な使い方

itemメソッドは、Dom\NodeListオブジェクトが保持するノードリストから、指定されたインデックスに対応するノードを取得するメソッドです。Dom\NodeListは、XMLやHTMLドキュメント内のノードの集合を表し、例えば、特定のタグを持つ要素のリストなどを取得する際に利用されます。

このメソッドは、整数型のインデックスを引数として受け取ります。インデックスは0から始まり、ノードリスト内の各ノードを一意に識別します。指定されたインデックスがノードリストの範囲内にある場合、対応するDom\Nodeオブジェクトが返されます。もしインデックスが範囲外である場合、つまり、リストに存在しないインデックスが指定された場合は、nullが返されます。

itemメソッドを利用することで、Dom\NodeList内のノードを順番に処理したり、特定の条件を満たすノードにアクセスしたりすることが容易になります。例えば、ループ処理と組み合わせることで、ノードリスト内のすべてのノードに対して、属性の取得、テキストの変更、子ノードの操作などの処理を適用できます。

XMLやHTMLドキュメントを解析し、特定の要素を操作するようなシステムを開発する際に、Dom\NodeListとitemメソッドは非常に重要な役割を果たします。例えば、Webスクレイピング、データ抽出、ドキュメント変換などの用途で頻繁に利用されます。適切にitemメソッドを使用することで、効率的かつ正確にドキュメント内の情報を処理することができます。

構文(syntax)


1public Dom\Node|null Dom\NodeList::item(int $index)

引数(parameters)

int $index

int $index: 取得したい要素のインデックス番号を指定する整数

戻り値(return)

?Dom\Node

指定されたインデックス位置にあるDom\Nodeオブジェクト、またはインデックスが無効な場合はnullを返します。

サンプルコード

PHP Dom\NodeList::item を使った要素取得


1<?php
2
3/**
4 * Dom\NodeList::item メソッドの使用例
5 * HTML ドキュメントから要素のリストを取得し、item() メソッドで特定のインデックスの要素にアクセスします。
6 * Dom\NodeList は、HTML コレクションを配列のようにインデックスで扱うことができます。
7 */
8
9// 1. 新しい Dom\Document インスタンスを作成
10$dom = new Dom\Document();
11
12// 2. 解析するHTMLコンテンツをロード
13$htmlContent = <<<HTML
14<!DOCTYPE html>
15<html>
16<head>
17    <title>サンプルページ</title>
18</head>
19<body>
20    <div id="container">
21        <p>これは最初の段落です。</p>
22        <p class="highlight">これは2番目の強調された段落です。</p>
23        <span>これは単なるスパン要素です。</span>
24    </div>
25</body>
26</html>
27HTML;
28
29// HTMLをDOMドキュメントにロードします。
30// エラー抑制演算子@は、HTML解析エラーが出力されるのを防ぐためによく使用されます。
31@$dom->loadHtml($htmlContent);
32
33// 3. 'p' タグを持つ全ての要素の Dom\NodeList を取得
34// getElementsByTagName() メソッドは、指定されたタグ名を持つ全ての要素を Dom\NodeList オブジェクトとして返します。
35$paragraphs = $dom->getElementsByTagName('p');
36
37echo "--- 段落要素の取得とアクセス ---\n";
38
39// 4. Dom\NodeList::item() メソッドを使用して、リスト内の特定の要素にアクセス
40// インデックス 0 の要素 (最初の <p> タグ) を取得します。
41$firstParagraph = $paragraphs->item(0);
42
43if ($firstParagraph instanceof Dom\Node) {
44    // 取得したノードが Dom\Node のインスタンスであるか確認します。
45    // item() メソッドは、指定されたインデックスに要素が存在しない場合、null を返します。
46    echo "最初の段落の内容: " . $firstParagraph->textContent . "\n";
47} else {
48    echo "インデックス 0 の要素は見つかりませんでした。\n";
49}
50
51// インデックス 1 の要素 (2番目の <p> タグ) を取得します。
52$secondParagraph = $paragraphs->item(1);
53
54if ($secondParagraph instanceof Dom\Node) {
55    echo "2番目の段落の内容: " . $secondParagraph->textContent . "\n";
56} else {
57    echo "インデックス 1 の要素は見つかりませんでした。\n";
58}
59
60// 5. 存在しないインデックスの要素を取得しようとする例
61// Dom\NodeList には 2つの <p> 要素しかないため、インデックス 2 は存在しません。
62// この場合、item() メソッドは null を返します。
63$nonExistentParagraph = $paragraphs->item(2);
64
65if ($nonExistentParagraph === null) {
66    echo "インデックス 2 の要素は存在しません (item() は null を返しました)。\n";
67} else {
68    // このブロックは実行されません。
69    echo "インデックス 2 の要素の内容: " . $nonExistentParagraph->textContent . "\n";
70}
71
72echo "\n--- リストの要素数とループ ---\n";
73
74// Dom\NodeList の要素数を確認
75echo "取得した段落の数: " . $paragraphs->length . "\n";
76
77// ループで全ての要素にアクセスすることも可能（item() を使う方法と、foreach を使う方法）
78echo "全ての段落の内容:\n";
79for ($i = 0; $i < $paragraphs->length; $i++) {
80    $paragraph = $paragraphs->item($i);
81    if ($paragraph instanceof Dom\Node) {
82        echo " - [" . $i . "] " . $paragraph->textContent . "\n";
83    }
84}

PHPのDom\NodeList::itemメソッドは、HTMLやXMLドキュメントから取得した要素のリストを扱うDom\NodeListオブジェクトにおいて、特定のインデックス（位置）にある要素を取り出すために使用されます。Dom\NodeListは、例えばDom\DocumentクラスのgetElementsByTagName()メソッドなどによって取得され、複数のHTML要素が集合体として格納されています。

このメソッドの引数int $indexには、取得したい要素がリストの何番目にあるかを示す数値を指定します。インデックスは0から始まるため、item(0)は最初の要素、item(1)は2番目の要素を指します。

戻り値は?Dom\Node型です。これは、指定されたインデックスに要素が存在する場合にその要素を表すDom\Nodeオブジェクトを返し、もし該当する要素が存在しない場合はnullを返すことを意味します。したがって、item()メソッドの呼び出し後は、戻り値がnullでないかを確認することで、目的の要素が正常に取得できたかを判断できます。

サンプルコードでは、まずHTMLコンテンツから複数の段落（<p>タグ）をDom\NodeListとして取得しています。その後、$paragraphs->item(0)でリストの最初の段落にアクセスし、その内容を表示しています。同様にitem(1)で2番目の段落にアクセスし、存在しないインデックスitem(2)を試みた際には、期待通りnullが返される様子も示されています。Dom\NodeListは、PHPにおける配列のようにインデックスを使って個々の要素に効率的にアクセスできる便利な機能です。また、lengthプロパティでリストの要素数を確認し、item()メソッドと組み合わせてループ処理を行うことで、リスト内の全ての要素を順に処理することも可能です。

Dom\NodeList::item()メソッドは、指定したインデックスに要素が存在しない場合、nullを返します。そのため、メソッドの戻り値がDom\Nodeのインスタンスであるか、またはnullであるかを必ず確認してください。このnullチェックを怠ると、存在しない要素に対してプロパティやメソッドを呼び出そうとした際にTypeErrorなどの実行時エラーが発生し、プログラムが停止する原因となります。リストの要素数はlengthプロパティで取得できますので、ループ処理などで利用する際は、このプロパティで範囲をチェックし、配列のインデックスのように安全にアクセスすることが重要です。