preg_match_all
(PHP 4, PHP 5, PHP 7, PHP 8)
preg_match_all — 執行一個全域性正規表示式匹配
說明
string
$pattern
,string
$subject
,array
&$matches
= null
,int
$flags
= 0,int
$offset
= 0): int|false|null
搜索subject
中所有匹配pattern
給定正規表示式
的匹配結果並且將它們以flag
指定順序輸出到matches
中.
在第一個匹配找到后, 子序列繼續從最後一次匹配位置搜索.
參數
-
pattern
-
要搜索的模式,字串形式。
-
subject
-
輸入字串。
-
matches
-
多維陣列,作為輸出參數輸出所有匹配結果, 陣列排序通過
flags
指定。 -
flags
-
可以結合下面標記使用(注意不能同時使用
PREG_PATTERN_ORDER
和PREG_SET_ORDER
):-
PREG_PATTERN_ORDER
-
結果排序為$matches[0]儲存完整模式的所有匹配, $matches[1] 儲存第一個子組的所有匹配,以此類推。
<?php
preg_match_all("|<[^>]+>(.*)</[^>]+>|U",
"<b>example: </b><div align=left>this is a test</div>",
$out, PREG_PATTERN_ORDER);
echo $out[0][0] . ", " . $out[0][1] . "\n";
echo $out[1][0] . ", " . $out[1][1] . "\n";
?>以上例程會輸出:
<b>example: </b>, <div align=left>this is a test</div> example: , this is a test
因此, $out[0]是包含匹配完整模式的字串的陣列, $out[1]是包含閉合標籤內的字串的陣列。
如果正規表示式包含了帶名稱的子組,$matches 額外包含了帶名稱子組的鍵。
如果正規表示式里,子組名稱重名了,則僅最右側的子組儲存在 $matches[NAME] 中。
<?php
preg_match_all(
'/(?J)(?<match>foo)|(?<match>bar)/',
'foo bar',
$matches,
PREG_PATTERN_ORDER
);
print_r($matches['match']);
?>以上例程會輸出:
Array ( [0] => [1] => bar )
-
PREG_SET_ORDER
-
結果排序為$matches[0]包含第一次匹配得到的所有匹配(包含子組), $matches[1]是包含第二次匹配到的所有匹配(包含子組)的陣列,以此類推。
<?php
preg_match_all("|<[^>]+>(.*)</[^>]+>|U",
"<b>example: </b><div align=\"left\">this is a test</div>",
$out, PREG_SET_ORDER);
echo $out[0][0] . ", " . $out[0][1] . "\n";
echo $out[1][0] . ", " . $out[1][1] . "\n";
?>以上例程會輸出:
<b>example: </b>, example: <div align="left">this is a test</div>, this is a test
-
PREG_OFFSET_CAPTURE
-
如果這個標記被傳遞,每個發現的匹配返回時會增加它相對目標字串的位元組偏移量。 注意這會改變
matches
中的每一個匹配結果字串元素,使其 成為一個第0
個元素為匹配結果字串,第1
個元素為 匹配結果字串在subject
中的偏移量。<?php
preg_match_all('/(foo)(bar)(baz)/', 'foobarbaz', $matches, PREG_OFFSET_CAPTURE);
print_r($matches);
?>以上例程會輸出:
Array ( [0] => Array ( [0] => Array ( [0] => foobarbaz [1] => 0 ) ) [1] => Array ( [0] => Array ( [0] => foo [1] => 0 ) ) [2] => Array ( [0] => Array ( [0] => bar [1] => 3 ) ) [3] => Array ( [0] => Array ( [0] => baz [1] => 6 ) ) )
-
PREG_UNMATCHED_AS_NULL
-
傳入此標記,未匹配的子組報告為
null
;否則會是空 string。
如果沒有給定排序標記,假定設定為
PREG_PATTERN_ORDER
。 -
-
offset
-
通常, 查詢時從目標字串的開始位置開始。可選參數
offset
用於 從目標字串中指定位置開始搜索(單位是位元組)。注意:
使用
offset
參數不同於傳遞substr($subject, $offset)
的 結果到 preg_match_all() 作為目標字串,因為pattern
可以包含斷言比如^, $ 或者 (?<=x) 。 示例檢視 preg_match()。
返回值
返回完整匹配次數(可能是0),或者如果發生錯誤返回false
。
更新日誌
版本 | 說明 |
---|---|
7.2.0 |
現在 $flags 參數可以支援 PREG_UNMATCHED_AS_NULL 。
|
範例
示例 #1 查詢所有文字中的電話號碼。
<?php
preg_match_all("/\(? (\d{3})? \)? (?(1) [\-\s] ) \d{3}-\d{4}/x",
"Call 555-1212 or 1-800-555-1212", $phones);
?>
示例 #2 查詢匹配的HTML標籤(貪婪)
<?php
//\\2是一個後向引用的示例. 這會告訴pcre它必須匹配正規表示式中第二個圓括號(這裡是([\w]+))
//匹配到的結果. 這裡使用兩個反斜線是因為這裡使用了雙引號.
$html = "<b>bold text</b><a href=howdy.html>click me</a>";
preg_match_all("/(<([\w]+)[^>]*>)(.*?)(<\/\\2>)/", $html, $matches, PREG_SET_ORDER);
foreach ($matches as $val) {
echo "matched: " . $val[0] . "\n";
echo "part 1: " . $val[1] . "\n";
echo "part 2: " . $val[2] . "\n";
echo "part 3: " . $val[3] . "\n";
echo "part 4: " . $val[4] . "\n\n";
}
?>
以上例程會輸出:
matched: <b>bold text</b> part 1: <b> part 2: b part 3: bold text part 4: </b> matched: <a href=howdy.html>click me</a> part 1: <a href=howdy.html> part 2: a part 3: click me part 4: </a>
示例 #3 使用子命名組
<?php
$str = <<<FOO
a: 1
b: 2
c: 3
FOO;
preg_match_all('/(?P<name>\w+): (?P<digit>\d+)/', $str, $matches);
/* 選擇方式 */
// preg_match_all('/(?<name>\w+): (?<digit>\d+)/', $str, $matches);
print_r($matches);
?>
以上例程會輸出:
Array ( [0] => Array ( [0] => a: 1 [1] => b: 2 [2] => c: 3 ) [name] => Array ( [0] => a [1] => b [2] => c ) [1] => Array ( [0] => a [1] => b [2] => c ) [digit] => Array ( [0] => 1 [1] => 2 [2] => 3 ) [2] => Array ( [0] => 1 [1] => 2 [2] => 3 ) )
參見
- PCRE 匹配
- preg_quote() - 轉義正規表示式字元
- preg_match() - 執行匹配正規表示式
- preg_replace() - 執行一個正規表示式的搜索和替換
- preg_split() - 通過一個正規表示式分隔字串
- preg_last_error() - 返回最後一個PCRE正則執行產生的錯誤程式碼