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

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

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

基本的な使い方

querySelectorAllメソッドは、Dom\Documentクラスに属するメソッドで、指定されたCSSセレクタに一致する要素をすべて取得し、Dom\NodeListオブジェクトとして返します。このメソッドは、ドキュメント全体から条件に合致する要素を効率的に検索するために使用されます。

具体的には、引数としてCSSセレクタ文字列を受け取り、そのセレクタに合致する要素をドキュメントツリー内で探索します。例えば、querySelectorAll('div.example') と記述すると、class属性が "example" であるすべてのdiv要素が検索されます。

返り値として得られるDom\NodeListオブジェクトは、取得された要素のリストを保持しており、配列のように扱うことができます。ただし、NodeListは通常の配列とは異なり、ライブコレクションであるため、ドキュメントの内容が変更されるとNodeListの内容も動的に更新されるという特徴があります。

querySelectorAllメソッドは、JavaScriptのquerySelectorとquerySelectorAllメソッドと同様の機能を提供しますが、PHPのDOM拡張機能の一部として動作します。そのため、PHPでサーバーサイドのDOM操作を行う際に非常に役立ちます。例えば、HTMLドキュメントをロードし、特定の条件を満たす要素を抽出し、その要素の内容を処理したり、属性を変更したりするなどの操作が可能です。

このメソッドを使用することで、複雑なHTML構造から必要な情報を効率的に抽出し、プログラム内で利用することができます。DOMDocumentクラスの他のメソッドと組み合わせることで、HTMLドキュメントの解析、編集、生成など、様々な処理を柔軟に行うことが可能になります。

構文(syntax)


1<?php
2
3$dom = new DomDocument();
4$dom->loadHTML('<html><body><div class="foo">test</div><div class="bar">test2</div></body></html>');
5
6$elements = $dom->querySelectorAll('div');
7
8foreach ($elements as $element) {
9  echo $element->nodeValue . PHP_EOL;
10}
11
12?>

引数(parameters)

string $selectors

string $selectors: 検索したい要素を指定するCSSセレクタ文字列

戻り値(return)

Dom\NodeList

Dom\NodeList オブジェクトを返します。このオブジェクトは、指定されたCSSセレクターに一致するすべてのDOMノードのコレクションです。

サンプルコード

PHP DomDocument querySelectorAll で要素を検索する


1<?php
2
3/**
4 * Dom\Document::querySelectorAll メソッドの使用例。
5 * HTML文字列から特定のCSSセレクタに一致する要素をすべて取得します。
6 *
7 * システムエンジニアを目指す初心者向けに、基本的なHTMLパースと要素検索のプロセスを示します。
8 */
9function demonstrateQuerySelectorAll(): void
10{
11    // 検索対象となるHTMLコンテンツを定義します。
12    // ここでは、複数のdiv要素とp要素が含まれる単純なHTMLを作成します。
13    $htmlContent = <<<HTML
14    <!DOCTYPE html>
15    <html>
16    <head>
17        <title>querySelector All Demo</title>
18    </head>
19    <body>
20        <h1>PHP Dom\Document::querySelectorAll の例</h1>
21        <p class="intro">これは導入の段落です。</p>
22        <div class="item active">
23            <span class="label">Item A:</span> 詳細コンテンツ
24        </div>
25        <div class="item">
26            <span class="label">Item B:</span> さらなる情報
27        </div>
28        <div class="item">
29            <span class="label">Item C:</span> 最後の項目
30        </div>
31        <p>これは普通の段落です。</p>
32    </body>
33    </html>
34    HTML;
35
36    // Dom\Document クラスの新しいインスタンスを作成します。
37    // このオブジェクトを使ってHTMLを解析し、DOMツリーとして扱います。
38    $document = new Dom\Document();
39
40    // 定義したHTML文字列をドキュメントに読み込みます。
41    // これにより、HTMLが解析され、DOMツリーが構築されます。
42    $document->loadHTML($htmlContent);
43
44    // querySelectorAll メソッドを使用して、特定のCSSセレクタに一致するすべての要素を検索します。
45    // ここでは、クラス名 "item" を持つすべての<div>要素を取得します。
46    // 戻り値は Dom\NodeList オブジェクトで、一致するノードの集合です。
47    $nodeList = $document->querySelectorAll('div.item');
48
49    echo "--- 検索結果 ---" . PHP_EOL;
50
51    // 取得したノードリストを反復処理し、各ノードの情報を表示します。
52    // Dom\NodeList は反復可能 (iterable) なので、foreach ループで直接使用できます。
53    // 各 $node は Dom\Element (または Dom\Nodeの子孫) のインスタンスです。
54    foreach ($nodeList as $index => $node) {
55        // textContent プロパティは、要素内のすべてのテキストコンテンツを返します。
56        echo "要素 #" . ($index + 1) . ": " . $node->textContent . PHP_EOL;
57        // getAttribute メソッドで、要素の特定の属性値を取得できます。
58        if ($node->hasAttribute('class')) {
59            echo "  クラス属性: " . $node->getAttribute('class') . PHP_EOL;
60        }
61    }
62
63    echo "----------------" . PHP_EOL;
64
65    // 別のセレクタで検索してみる例: すべての <p> 要素
66    echo PHP_EOL . "--- すべての <p> 要素の検索 ---" . PHP_EOL;
67    $paragraphList = $document->querySelectorAll('p');
68    foreach ($paragraphList as $index => $paragraph) {
69        echo "段落 #" . ($index + 1) . ": " . $paragraph->textContent . PHP_EOL;
70    }
71    echo "---------------------------" . PHP_EOL;
72}
73
74// 関数を実行して、Dom\Document::querySelectorAll の動作を確認します。
75demonstrateQuerySelectorAll();
76
77?>

このサンプルコードは、PHPを使ってHTMLコンテンツから特定の要素を検索する方法を実演しています。まず、Dom\Documentクラスのオブジェクトを作成し、準備されたHTML文字列をloadHTMLメソッドで読み込みます。これにより、HTMLはプログラムで操作可能なツリー構造（DOMツリー）としてメモリ上に構築されます。

次に、Dom\Document::querySelectorAllメソッドが使用されます。このメソッドは、引数として指定されたCSSセレクタに一致するHTML要素をすべて検索し、その結果をDom\NodeListオブジェクトとして返します。引数string $selectorsには、HTML要素のクラス名やタグ名などを指定するCSSセレクタの文字列を渡します。例えば、div.itemと指定すると、クラス名が"item"のdiv要素がすべて選択されます。

戻り値であるDom\NodeListは、一致した複数の要素をリスト形式で格納しており、foreachループを使って簡単に一つ一つの要素にアクセスできます。ループ内では、各要素のtextContentプロパティを使ってそのテキスト内容を取得したり、getAttributeメソッドを使って特定の属性値を取り出したりできます。このように、querySelectorAllメソッドはHTMLドキュメント内の情報を効率的に抽出し、プログラムで活用するための基本的な機能を提供します。

Dom\DocumentでHTMLを解析するには、loadHTML()メソッドでHTML文字列を正確に読み込む必要があります。不正なHTMLの場合、パース時に警告やエラーが発生することがあるため、エラーハンドリングを考慮しましょう。querySelectorAll()メソッドの引数には、CSSセレクタの形式で検索条件を指定します。クラス名には.、ID名には#をそれぞれ正しく使いましょう。このメソッドは、一致する要素の有無に関わらず、常にDom\NodeListという要素のリストを返します。そのため、結果はforeachなどで反復処理するのが基本です。一致する要素がない場合でもエラーにはならず、空のDom\NodeListが返されます。取得した各要素からtextContentプロパティでテキスト内容を、getAttribute()メソッドで属性値を取得できます。