preg_match

(PHP 4, PHP 5, PHP 7, PHP 8)

preg_match — 執(zhí)行匹配正則表達式

說明

preg_match(
    string $pattern,
    string $subject,
    array &$matches = null,
    int $flags = 0,
    int $offset = 0
): int|false

搜索subject與pattern給定的正則表達式的一個匹配.

參數(shù)

pattern

要搜索的模式，字符串類型。

subject

輸入字符串。

matches

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

flags

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

PREG_OFFSET_CAPTURE

如果傳遞了這個標記，對于每一個出現(xiàn)的匹配返回時會附加字符串偏移量(相對于目標字符串的字節(jié)數(shù))。 注意：這會改變填充到matches參數(shù)的數(shù)組，使其每個元素成為一個由 第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

通常，搜索從目標字符串的開始位置開始?？蛇x參數(shù) offset 用于 指定從目標字符串的某個位置開始搜索(單位是字節(jié))。

注意:

使用offset參數(shù)不同于向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 參數(shù)一起運行。

返回值

preg_match()返回 pattern 的匹配次數(shù)。 它的值將是0次（不匹配）或1次，因為preg_match()在第一次匹配后 將會停止搜索。preg_match_all()不同于此，它會一直搜索subject 直到到達結尾。 如果發(fā)生錯誤preg_match()返回 false。

更新日志

版本 說明
7.2.0 現(xiàn)在 $flags 參數(shù)支持 PREG_UNMATCHED_AS_NULL。

范例

示例 #1 查找文本字符串"php"

<?php
//模式分隔符后的"i"標記這是一個大小寫不敏感的搜索
if (preg_match("/php/i", "PHP is the web scripting language of choice.")) {
    echo "A match was found.";
} else {
    echo "A match was not found.";
}
?>

示例 #2 查找單詞"word"

<?php
/* 模式中的\b標記一個單詞邊界，所以只有獨立的單詞"web"會被匹配，而不會匹配
 * 單詞的部分內容比如"webbing" 或 "cobweb" */
if (preg_match("/\bweb\b/i", "PHP is the web scripting language of choice.")) {
    echo "A match was found.";
} else {
    echo "A match was not found.";
}

if (preg_match("/\bweb\b/i", "PHP is the website scripting language of choice.")) {
    echo "A match was found.";
} else {
    echo "A match was not found.";
}
?>

示例 #3 獲取URL中的域名

<?php
//從URL中獲取主機名稱
preg_match('@^(?:http://)?([^/]+)@i',
    "http://www.php.net/index.html", $matches);
$host = $matches[1];

//獲取主機名稱的后面兩部分
preg_match('/[^.]+\.[^.]+$/', $host, $matches);
echo "domain name is: {$matches[0]}\n";
?>

以上例程會輸出：

domain name is: php.net

示例 #4 使用命名子組

<?php

$str = 'foobar: 2008';

preg_match('/(?P<name>\w+): (?P<digit>\d+)/', $str, $matches);

/* 可選的方式 */
// preg_match('/(?<name>\w+): (?<digit>\d+)/', $str, $matches);

print_r($matches);

?>

以上例程會輸出：

Array
(
    [0] => foobar: 2008
    [name] => foobar
    [1] => foobar
    [digit] => 2008
    [2] => 2008
)

注釋

小技巧

如果你僅僅想要檢查某個字符串是否包含另外一個字符串，不要使用preg_match()。 使用 strpos() 會更快。

參見