【PHP8.x】querySelectorメソッドの使い方
querySelectorメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
querySelectorメソッドは、PHPのDom\XMLDocumentクラスに属し、XMLドキュメントの中から特定の条件に合致する最初の要素を検索、取得するメソッドです。このメソッドは、ウェブページ（HTML）の要素を操作する際によく利用されるCSSセレクターの構文を用いて、XML構造内の特定の要素を効率的に見つけ出すことを可能にします。
具体的には、XMLドキュメント全体、または特定の要素を起点として、指定されたCSSセレクターパターンに一致する最初の要素を探し出します。例えば、「idがproduct-infoの要素」や「クラスがitem-priceを持つ要素」、あるいは「特定のタグ名を持つ要素」といった形で、直感的に目的の要素を指定できます。これにより、複雑なXMLデータの中から、必要な情報を持つ特定の要素に素早くアクセスすることが可能になります。
検索の結果、セレクターに合致する要素がドキュメント内に見つかった場合、このメソッドはその要素を表すDOMNodeオブジェクトを返します。もし、指定したセレクターに一致する要素が一つも見つからなかった場合は、nullを返します。したがって、このメソッドを利用した後は、返された値がnullでないかを確認することが重要です。
システムエンジニアを目指す方にとって、XMLデータの解析や操作は多くの場面で必要となるスキルです。querySelectorメソッドは、特に一つの特定の要素にアクセスしたい場合に、そのコードを簡潔にし、可読性を高める強力なツールとなります。複数の要素を取得したい場合には、関連するquerySelectorAllメソッドの利用も検討してください。
構文(syntax)
1<?php 2 3$xmlDocumentInstance = new Dom\XMLDocument(); 4$xmlDocumentInstance->loadXML('<root><item id="unique-id">Example Text</item></root>'); 5 6// Dom\XMLDocument::querySelector メソッドの呼び出し構文 7// 引数: string (CSSセレクタ文字列) 8// 戻り値: Dom\Element|null (マッチした最初の要素、またはマッチしなかった場合はnull) 9$domElementOrNull = $xmlDocumentInstance->querySelector('#unique-id');
引数(parameters)
string $selectors
- string $selectors: DOM要素を検索するためのCSSセレクター文字列
戻り値(return)
?Dom\Element
指定されたCSSセレクタに一致する最初の要素をDom\Elementオブジェクトとして返します。一致する要素が見つからなかった場合はnullを返します。
サンプルコード
PHP DOMDocument querySelectorで要素を取得する
1<?php 2 3// HTML文字列を読み込む 4$html = <<<HTML 5<!DOCTYPE html> 6<html> 7<head> 8 <title>querySelector Example</title> 9</head> 10<body> 11 <div id="container"> 12 <p class="paragraph">First paragraph.</p> 13 <p class="paragraph">Second paragraph.</p> 14 </div> 15</body> 16</html> 17HTML; 18 19// DomDocumentオブジェクトを作成 20$dom = new DOMDocument(); 21 22// HTMLをロード 23$dom->loadHTML($html); 24 25// DomXPathオブジェクトを作成 26$xpath = new DOMXPath($dom); 27 28// querySelectorを使って最初の.paragraph要素を取得 29$element = $dom->querySelector('.paragraph'); 30 31// 要素が存在する場合、テキストコンテンツを出力 32if ($element) { 33 echo $element->textContent . PHP_EOL; 34} else { 35 echo "Element not found." . PHP_EOL; 36} 37 38// querySelectorAllを使ってすべての.paragraph要素を取得 39$elements = $xpath->query('//p[@class="paragraph"]'); 40 41// すべての要素のテキストコンテンツを出力 42foreach ($elements as $element) { 43 echo $element->textContent . PHP_EOL; 44} 45 46?>
PHPのDom\XMLDocumentクラスのquerySelectorメソッドは、CSSセレクタを使用して、ドキュメント内で最初に一致する要素を検索します。引数$selectorsには、検索に使用するCSSセレクタを文字列で指定します。戻り値は、一致する最初のDom\Elementオブジェクトです。一致する要素が見つからない場合はnullを返します。
このサンプルコードでは、まずHTML文字列をDOMDocumentオブジェクトに読み込みます。次に、querySelectorメソッドを使用して、クラス名がparagraphである最初の<p>要素を取得しています。取得した要素が存在する場合は、そのテキストコンテンツを標準出力に出力します。
querySelectorと似た機能として、XPathを使った要素の取得も可能です。サンプルコードではDOMXPathオブジェクトを作成し、queryメソッドを使ってすべての<p>要素（クラス名がparagraphのもの）を取得しています。取得した要素はDOMNodeListオブジェクトとして返されるため、foreachループで各要素のテキストコンテンツを出力しています。
querySelectorを使用することで、CSSセレクタの知識を活かして、特定の要素を効率的に検索できます。XPathでの要素取得はquerySelectorAllと似た機能を提供しますが、より複雑な条件での要素検索が可能です。この例ではXPathのqueryメソッドに//p[@class="paragraph"]というXPath式を渡すことで、すべての<p>要素の中からclass属性が"paragraph"であるものを選択しています。querySelectorは最初にマッチした要素のみを返すのに対し、XPathのqueryメソッドは条件に一致するすべての要素を返します。
querySelectorは、指定したCSSセレクタに最初に一致する要素を返します。一致する要素がない場合はnullを返します。querySelectorAllのように複数の要素を取得したい場合は、DOMXPathオブジェクトのqueryメソッドを使用する必要があります。queryメソッドはXPath式を使用するため、CSSセレクタとは異なる記述方法になる点に注意してください。サンプルコードでは、querySelectorで.paragraphクラスの最初の要素を取得し、queryメソッドで.paragraphクラスのすべての要素を取得しています。HTMLの構造によっては、予期しない要素が選択される可能性があるため、セレクタはできるだけ具体的に記述することをお勧めします。また、loadHTMLメソッドでHTMLを読み込む際、文字コードの問題が発生することがあります。必要に応じてmb_convert_encoding関数などを使用して文字コードを変換してください。
PHP DomDocumentで要素を検索する
1<?php 2 3// HTML文字列をロードする 4$html = <<<HTML 5<!DOCTYPE html> 6<html> 7<head> 8 <title>querySelector Example</title> 9</head> 10<body> 11 <div id="container"> 12 <p class="item">Item 1</p> 13 <p class="item">Item 2</p> 14 <p class="item special">Item 3</p> 15 </div> 16</body> 17</html> 18HTML; 19 20$dom = new DOMDocument(); 21$dom->loadHTML($html); 22 23$xpath = new DOMXPath($dom); 24 25// querySelectorで最初の要素を取得 26$element = $xpath->query('//p[@class="item special"]')[0]; 27 28 29if ($element) { 30 echo $element->nodeValue . PHP_EOL; // Item 3 31} else { 32 echo "Element not found." . PHP_EOL; 33} 34 35// querySelectorAllの代替として、XPathで複数の要素を取得する 36$elements = $xpath->query('//p[@class="item"]'); 37 38foreach ($elements as $element) { 39 echo $element->nodeValue . PHP_EOL; 40} 41// Item 1 42// Item 2 43// Item 3
このサンプルコードは、PHPのDOM拡張を使って、HTMLドキュメントから特定の要素をXPathで検索する方法を示しています。具体的には、Dom\XMLDocument クラスの querySelector メソッド（のような動作）と querySelectorAll メソッド（のような動作）をXPathで代替する例です。
まず、HTML文字列を $dom->loadHTML() で DOMDocument オブジェクトに読み込みます。次に、DOMXPath オブジェクトを作成し、これを使ってXPathクエリを実行します。
$xpath->query('//p[@class="item special"]')[0] は、XPathを使って <p> タグで class 属性が "item special" である最初の要素を取得します。querySelectorのように単一の要素を取得したい場合は、XPathの結果セットの最初の要素にアクセスします。取得した要素が存在する場合、その要素のテキストコンテンツ (nodeValue) を出力します。
次に、$xpath->query('//p[@class="item"]') は、<p> タグで class 属性が "item" であるすべての要素を取得します。querySelectorAllのように複数の要素を取得したい場合は、XPathの結果セットをループ処理します。取得した各要素のテキストコンテンツを順に出力します。
querySelectorメソッドはPHPのDOM拡張には存在しないため、XPathを使用することで同様の処理を実現できます。引数 $selectors にはXPathのセレクタ文字列を指定し、戻り値は条件に合致する最初の Dom\Element オブジェクト、見つからない場合は null に相当する値（この例ではXPathの結果が空のNodeListになること）となります。
Dom\XMLDocument::querySelectorはPHP8.0以降で利用可能です。しかし、PHPには標準でquerySelectorAllメソッドが存在しません。そのため、XPathを利用して同様の結果を得る必要があります。上記のサンプルコードでは、querySelectorの代替としてXPathのqueryメソッドを使用しています。XPathのクエリは、HTMLの構造を正確に把握していないと意図した要素を取得できない場合があります。また、$xpath->query()はDOMNodeListを返すため、最初の要素にアクセスするには[0]のようにインデックスを指定する必要があります。要素が存在しない場合はエラーになる可能性があるため、if ($element)で存在を確認してから利用することが推奨されます。セキュリティ面では、外部からの入力に基づいてXPathクエリを生成する場合、XPathインジェクション攻撃のリスクがあるため、注意が必要です。