Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】Dom\ParentNode::querySelectorAll()メソッドの使い方

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

作成日: 更新日:

基本的な使い方

querySelectorAllメソッドは、指定されたCSSセレクタに一致する全ての子孫要素を取得するメソッドです。このメソッドはDom\ParentNodeクラスに属し、Dom\DocumentDom\Elementなどの、子ノードを持つオブジェクトから呼び出されます。

引数にはCSSセレクタ文字列を渡します。例えば、「.item」(class属性が"item"の要素)や「#main」(id属性が"main"の要素)のように指定することで、呼び出し元の要素の子孫の中から、その条件に合致する要素をすべて検索します。

一致する要素が見つかった場合、それらはDom\NodeListオブジェクトとして返されます。Dom\NodeListは、取得された複数の要素を格納するコレクションであり、for-eachループなどで個々の要素にアクセスし、処理を行うことができます。一致する要素が一つもなければ、空のDom\NodeListが返されます。

このメソッドは、HTMLやXML文書の特定の要素群を効率的に選択し、プログラムでその内容を読み取ったり、動的に変更したりする際に非常に有用です。ウェブスクレイピングやWebアプリケーションでのDOM操作において、中心的な役割を果たす機能の一つとして広く利用されています。

構文(syntax)

1<?php
2
3$parentNode = new DOMDocument(); // Dom\ParentNode の具体的なインスタンス(例として DOMDocument)
4$parentNode->loadHTML('<div><span class="my-class">Hello</span><p class="my-class">World</p></div>');
5
6$nodeList = $parentNode->querySelectorAll(string $cssSelectors);
7
8?>

引数(parameters)

string $selectors

  • string $selectors: 検索するCSSセレクタを指定する文字列

戻り値(return)

Dom\NodeList

指定されたCSSセレクタに一致するすべての要素のリストを返します。このリストはDom\NodeListクラスのインスタンスです。

サンプルコード

PHP DomDocument querySelectorAllで要素を検索する

1<?php
2
3// サンプルとなるHTML文字列を定義します。
4// このHTMLを解析して、要素を選択するデモンストレーションを行います。
5$htmlContent = <<<HTML
6<!DOCTYPE html>
7<html>
8<head>
9    <title>DOM クエリのサンプルページ</title>
10</head>
11<body>
12    <div id="container">
13        <h1>DOM操作の基本</h1>
14        <p class="intro">これは最初の段落で、クラス 'intro' を持っています。</p>
15        <p>これは2番目の段落です。</p>
16        <ul>
17            <li>アイテム1</li>
18            <li class="highlight">アイテム2 (ハイライト)</li>
19            <li>アイテム3</li>
20        </ul>
21        <div class="footer">
22            <p>著作権 &copy; 2023</p>
23            <span class="contact">お問い合わせ</span>
24        </div>
25    </div>
26</body>
27</html>
28HTML;
29
30// Dom\Document オブジェクトを新しく作成します。
31// このオブジェクトは、HTMLやXML文書全体を表現するために使用されます。
32$document = new Dom\Document();
33
34// 定義したHTML文字列をDom\Documentオブジェクトにロードして解析します。
35// これにより、HTMLの構造がPHPのオブジェクトツリーとして扱えるようになります。
36// loadHTML() はエラーを発生させることがありますが、ここではシンプルさを優先し、@ などのエラー抑制は行いません。
37$document->loadHTML($htmlContent);
38
39echo "--- すべての <p> (段落) タグのテキストコンテンツ ---" . PHP_EOL;
40
41// querySelectorAll メソッドを使用して、CSSセレクタにマッチするすべての要素を取得します。
42// ここでは、すべての <p> (段落) タグを選択しています。
43// 戻り値は Dom\NodeList で、マッチする要素のコレクションです。
44$paragraphs = $document->querySelectorAll('p');
45
46// 取得した Dom\NodeList をループ処理し、各段落のテキストコンテンツを表示します。
47foreach ($paragraphs as $index => $paragraph) {
48    // Dom\Element オブジェクトは Dom\Node を継承しており、textContent プロパティを通じて
49    // その要素とその子孫要素の結合されたテキストを取得できます。
50    echo "  段落 " . ($index + 1) . ": " . $paragraph->textContent . PHP_EOL;
51}
52
53echo PHP_EOL; // 見やすいように改行
54
55echo "--- クラス 'highlight' を持つ <li> (リストアイテム) タグのテキストコンテンツ ---" . PHP_EOL;
56
57// 別の例として、特定のクラス名を持つ <li> タグを選択してみましょう。
58// セレクタ 'li.highlight' は、「クラス名が 'highlight' の <li> タグ」を意味します。
59$highlightedItems = $document->querySelectorAll('li.highlight');
60
61// 取得したハイライトされたアイテムをループして表示します。
62foreach ($highlightedItems as $item) {
63    echo "  ハイライトされたアイテム: " . $item->textContent . PHP_EOL;
64}
65

Dom\ParentNode::querySelectorAllメソッドは、PHPでHTMLやXML文書を扱う際に、指定したCSSセレクタに合致するすべての要素を取得するために使用されます。

このメソッドはDom\ParentNodeクラスに属しており、HTML文書全体を表すDom\Documentオブジェクトなどから呼び出します。引数にはstring $selectorsとして、要素を指定するためのCSSセレクタを表す文字列を渡します。例えば、すべての段落タグ(<p>)を取得したい場合は'p'、特定のクラス名(例: 'highlight')を持つリストアイテム(<li>)を取得したい場合は'li.highlight'のように記述します。

メソッドの戻り値はDom\NodeListというオブジェクトで、これは指定したセレクタにマッチしたすべての要素を格納するコレクション(リスト)です。このDom\NodeListは、foreachループを使って個々の要素を順に処理することができ、各要素のテキスト内容などを取得・操作することが可能になります。

サンプルコードでは、まずHTML文字列をDom\Documentに読み込み、解析しています。その後、$document->querySelectorAll('p')でページ内のすべての段落タグを取得し、それぞれのテキスト内容を表示しています。さらに、$document->querySelectorAll('li.highlight')の例では、クラス名がhighlightのリストアイテムのみを選択し、そのテキスト内容を表示しています。このように、CSSセレクタを使うことで、HTML文書内の目的の要素を効率的に見つけ出すことができます。

Dom\Document::loadHTMLメソッドはHTMLのパース中にエラーを発生させる可能性があるため、実際のシステムではエラーチェックや適切なエラー処理を実装することが重要です。querySelectorAllメソッドはCSSセレクタを引数にとりますが、このセレクタの記述が誤っていると、意図した要素が取得できなかったり、空のリストが返されたりしますので、正確なCSSセレクタの知識が求められます。戻り値は常にDom\NodeListという要素の集合体であり、マッチする要素が一つもなくても空のリストが返されます。単一の要素を取得したい場合でも、このリストをループ処理して目的の要素にアクセスするのが一般的です。

関連コンテンツ