【PHP8.x】querySelectorAllメソッドの使い方
querySelectorAllメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
querySelectorAllメソッドは、Dom\DocumentFragmentオブジェクト内で指定されたCSSセレクタに一致する全ての子孫要素を取得するメソッドです。このメソッドは、HTMLやXMLのようなマークアップ言語で記述されたドキュメントの断片から、特定の条件に合致する複数の要素を効率的に見つけ出し、それらに対して一括で処理を行いたい場合に非常に有用です。
このメソッドは、唯一の引数としてCSSセレクタ文字列を受け取ります。このセレクタは、Web開発において要素を特定するために一般的に使用される形式であり、「#myId」（特定のIDを持つ要素）、「.myClass」（特定のクラスを持つ要素）、「a[target='_blank']」（target属性が'_blank'のa要素）など、多様な条件を指定できます。
メソッドが実行されると、Dom\DocumentFragmentが保持する全ての子孫要素を内部的に走査し、指定されたCSSセレクタの条件に合致するノードをすべて収集します。検索の結果、条件に一致する要素が一つでも見つかった場合、それらの要素を順序付けて格納したDom\NodeListオブジェクトとして返します。このDom\NodeListは、あたかも配列のように個々の要素にアクセスして、その内容の取得や変更、あるいはイベントリスナーの設定など、様々な操作を行うことができます。もし、指定されたセレクタに一致する要素が一つも見つからなかった場合でも、エラーは発生せず、要素を含まない空のDom\NodeListを返します。
この機能は、例えば、特定のクラスが適用されている全ての画像要素をまとめて非表示にしたり、特定のデータ属性を持つ全ての入力フィールドの値を変更したりといった、複数の要素に対する一括的な操作の基盤を構築する際に非常に強力な手段となります。なお、類似するquerySelectorメソッドは最初にマッチした単一の要素のみを返すため、複数の要素を対象とする場合はquerySelectorAllメソッドを利用するのが適切です。
構文(syntax)
1<?php 2 3$document = new Dom\Document(); 4$document->loadHTML(' 5 <div class="product-list"> 6 <h2 class="title">Available Products</h2> 7 <p class="item">Laptop</p> 8 <span>Price: $1200</span> 9 <p class="item">Mouse</p> 10 </div> 11'); 12 13$fragment = $document->createDocumentFragment(); 14$body = $document->getElementsByTagName('body')->item(0); 15if ($body) { 16 foreach ($body->childNodes as $node) { 17 $fragment->appendChild($document->importNode($node, true)); 18 } 19} 20 21$nodeList = $fragment->querySelectorAll('.item'); 22 23?>
引数(parameters)
string $selectors
- string $selectors: 検索したいCSSセレクタを指定する文字列
戻り値(return)
Dom\NodeList
指定されたCSSセレクターに一致するすべての要素のリストを返します。このリストはDom\NodeListクラスのインスタンスです。
サンプルコード
PHP DomDocumentFragment querySelectorAllで要素を取得する
1<?php 2 3// DomDocumentFragment と querySelectorAll を使用する例 4$html = <<<HTML 5<div> 6 <p class="example">This is a paragraph.</p> 7 <a href="#">A link</a> 8 <span class="example">Some text.</span> 9</div> 10HTML; 11 12// DomDocumentFragment を作成 13$fragment = new DOMDocumentFragment(); 14 15// DomDocument を作成 (DomDocumentFragment に HTML を読み込むには DomDocument が必要) 16$dom = new DOMDocument(); 17$dom->loadHTML($html); 18 19// body の子ノードを DomDocumentFragment に追加 20foreach ($dom->getElementsByTagName('body')->item(0)->childNodes as $node) { 21 $fragment->appendChild($dom->importNode($node, true)); 22} 23 24 25// querySelectorAll を使用して、class が "example" の要素をすべて取得 26$elements = $fragment->querySelectorAll('.example'); 27 28// 取得した要素の数を表示 29echo "Found " . $elements->count() . " elements with class 'example':\n"; 30 31// 取得した要素の内容を表示 32foreach ($elements as $element) { 33 echo $element->nodeValue . "\n"; 34} 35 36?>
PHPのDomDocumentFragmentクラスのquerySelectorAllメソッドは、指定されたCSSセレクタに一致する要素を、フラグメント（ドキュメントの一部）の中から検索するために使用します。このメソッドはPHP 8以降で使用可能です。
このサンプルコードでは、まずDomDocumentFragmentオブジェクトを作成しています。DomDocumentFragmentは、XMLドキュメントの一部分を保持するために使用されます。querySelectorAllメソッドはDomDocumentFragmentオブジェクトに対して呼び出されます。
次に、HTML文字列をDomDocumentにロードし、そのDomDocumentからDomDocumentFragmentにノードをインポートしています。これは、DomDocumentFragmentが直接HTMLを解析できないためです。
querySelectorAll('.example')は、クラス名が"example"の要素をすべて選択します。引数$selectorsには、検索に使用するCSSセレクタ文字列を指定します。
querySelectorAllメソッドは、DomNodeListオブジェクトを返します。DomNodeListは、一致する要素のリストです。サンプルコードでは、count()メソッドを使って、見つかった要素の数を表示し、foreachループを使って、各要素のnodeValue（テキスト内容）を表示しています。
この例では、HTML内にクラス名が"example"の要素が2つ（<p>と<span>）存在するため、querySelectorAllはこれら2つの要素をDomNodeListとして返します。そして、それぞれの要素の内容（"This is a paragraph."と"Some text."）が出力されます。querySelectorAllメソッドを使用することで、特定の条件に合致する要素を効率的に取得し、処理することができます。
DomDocumentFragmentのquerySelectorAllメソッドは、CSSセレクタを使って要素を検索する際に便利です。しかし、DomDocumentFragment単体ではHTMLを直接読み込めないため、DomDocumentを介してHTMLを読み込み、ノードをDomDocumentFragmentにインポートする必要があります。importNodeメソッドを使用する際は、第二引数をtrueにすることで、ノードのsubtree全体をコピーするようにしてください。querySelectorAllメソッドの引数 $selectors には、有効なCSSセレクタ文字列を指定する必要があります。セレクタの記述ミスがあると、期待通りの結果が得られない可能性があります。戻り値はDomNodeListオブジェクトであり、配列のように扱えますが、通常の配列関数は使えません。count()メソッドで要素数を取得したり、foreachループで要素を処理したりする必要があります。