參數

pattern

要搜索的模式，字串型別。

subject

輸入字串。

matches

如果提供了參數matches，它將被填充為搜索結果。 $matches[0]將包含完整模式匹配到的文字， $matches[1] 將包含第一個捕獲子組匹配到的文字，以此類推。

flags

flags 可以被設定為以下標記值的組合：

PREG_OFFSET_CAPTURE

如果傳遞了這個標記，對於每一個出現的匹配返回時會附加字串偏移量(相對於目標字串的位元組數)。 注意：這會改變填充到matches參數的陣列，使其每個元素成為一個由 第0個元素是匹配到的字串，第1個元素是該匹配字串 在目標字串subject中的偏移量。

<?php
preg_match('/(foo)(bar)(baz)/', 'foobarbaz', $matches, PREG_OFFSET_CAPTURE);
print_r($matches);
?>

以上例程會輸出：

Array
(
    [0] => Array
        (
            [0] => foobarbaz
            [1] => 0
        )

    [1] => Array
        (
            [0] => foo
            [1] => 0
        )

    [2] => Array
        (
            [0] => bar
            [1] => 3
        )

    [3] => Array
        (
            [0] => baz
            [1] => 6
        )

)

PREG_UNMATCHED_AS_NULL

使用該標記，未匹配的子組會報告為 null；未使用時，報告為空的 string。

<?php
preg_match('/(a)(b)*(c)/', 'ac', $matches);
var_dump($matches);
preg_match('/(a)(b)*(c)/', 'ac', $matches, PREG_UNMATCHED_AS_NULL);
var_dump($matches);
?>

以上例程會輸出：

array(4) {
  [0]=>
  string(2) "ac"
  [1]=>
  string(1) "a"
  [2]=>
  string(0) ""
  [3]=>
  string(1) "c"
}
array(4) {
  [0]=>
  string(2) "ac"
  [1]=>
  string(1) "a"
  [2]=>
  NULL
  [3]=>
  string(1) "c"
}

offset

通常，搜索從目標字串的開始位置開始。可選參數 offset 用於 指定從目標字串的某個位置開始搜索(單位是位元組)。

注意:

使用offset參數不同於向preg_match() 傳遞按照位置通過substr($subject, $offset)擷取目標字串結果， 因為pattern可以包含斷言比如^， $ 或者(?<=x)。 比較：

<?php
$subject = "abcdef";
$pattern = '/^def/';
preg_match($pattern, $subject, $matches, PREG_OFFSET_CAPTURE, 3);
print_r($matches);
?>

以上例程會輸出：

Array
(
)

當這個示例使用擷取後傳遞時

<?php
$subject = "abcdef";
$pattern = '/^def/';
preg_match($pattern, substr($subject,3), $matches, PREG_OFFSET_CAPTURE);
print_r($matches);
?>

將會產生匹配

Array
(
    [0] => Array
        (
            [0] => def
            [1] => 0
        )

)

要避免使用 substr()，可以用 \G 斷言而不是 ^ 錨，或者 A 修改器，它們都能和 offset 參數一起執行。