【PHP8.x】PREG_SET_ORDER定数の使い方

PREG_SET_ORDER定数は、PHPの正規表現関数において、正規表現のマッチ結果を格納する配列の構造を制御するために使用される定数です。特に、preg_match_all関数にオプションとして指定する際にその挙動が顕著になります。preg_match_all関数は、文字列内で正規表現に一致するすべてのパターンを検索し、その結果を多次元配列として返します。

この定数をpreg_match_all関数のflags引数に指定すると、返される結果配列は、「マッチした各セット（正規表現全体への一致と、その中に含まれる各サブパターンへの一致）」が、それぞれ一つのまとまりとして格納される形式になります。具体的には、最初に見つかった正規表現の全体一致とそのサブパターン一致の結果が配列の最初の要素（例えば$matches[0]）として格納され、次に見つかった一致セットが次の要素（$matches[1]）として格納される、というように、マッチした順序でデータがグループ化されます。

この配列構造は、検出された個々のマッチを、その全体と関連する部分（サブパターン）とをセットとしてまとめて扱いたい場合に非常に便利です。例えば、複数のタグや特定のデータブロックを文字列から抽出し、それぞれのブロックの内容を個別に処理したい場合に、PREG_SET_ORDERを使用することで、プログラムのロジックをより直感的かつ簡潔に記述することが可能になります。

Copy
1<?php
2$subject = "The quick brown fox jumps over the lazy dog. Fox and dog.";
3$pattern = '/(fox|dog)/i';
4$matches = [];
5
6preg_match_all($pattern, $subject, $matches, PREG_SET_ORDER);
7
8// $matches 配列は、各マッチ全体が最初のエントリとなり、
9// その後にキャプチャグループが続く形で構造化されます。
10// 例:
11// [
12//     [0] => "fox", // マッチ全体
13//     [1] => "fox"  // 最初のキャプチャグループ
14// ],
15// [
16//     [0] => "dog", // マッチ全体
17//     [1] => "dog"  // 最初のキャプチャグループ
18// ]
19?>

引数なし

引数はありません

int

PREG_SET_ORDER は、preg_match_all() 関数で使用される定数です。この定数は、マッチしたすべての結果を、各マッチごとに配列として格納する形式で返します。