preg_replace

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

preg_replace — 執(zhí)行一個正則表達式的搜索和替換

說明

preg_replace(
    string|array $pattern,
    string|array $replacement,
    string|array $subject,
    int $limit = -1,
    int &$count = null
): string|array|null

搜索 subject 中匹配 pattern 的部分，以 replacement 進行替換。

參數(shù)

pattern

要搜索的模式。可以使一個字符串或字符串數(shù)組。

可以使用一些 PCRE 修飾符。

replacement

用于替換的字符串或字符串數(shù)組。如果這個參數(shù)是一個字符串，并且 pattern 是一個數(shù)組，那么所有的模式都使用這個字符串進行替換。如果 pattern 和 replacement 都是數(shù)組，每個 pattern 使用 replacement 中對應的元素進行替換。如果 replacement 中的元素比 pattern 中的少，多出來的 pattern 使用空字符串進行替換。

replacement 中可以包含后向引用 \\n 或 $n，語法上首選后者。 每個這樣的引用將被匹配到的第 n 個捕獲子組捕獲到的文本替換。 n 可以是0-99，\\0 和 $0 代表完整的模式匹配文本。捕獲子組的序號計數(shù)方式為：代表捕獲子組的左括號從左到右， 從1開始數(shù)。如果要在 replacement 中使用反斜線，必須使用 4 個("\\\\"，譯注：因為這首先是 PHP 的字符串，經(jīng)過轉義后，是兩個，再經(jīng)過正則表達式引擎后才被認為是一個原文反斜線)。

當在替換模式下工作并且后向引用后面緊跟著需要是另外一個數(shù)字 (比如：在一個匹配模式后緊接著增加一個原文數(shù)字)，不能使用 \\1 這樣的語法來描述后向引用。比如，\\11將會使preg_replace() 不能理解你希望的是一個 \\1 后向引用緊跟一個原文 1，還是一個 \\11 后向引用后面不跟任何東西。 這種情況下解決方案是使用 ${1}1。這創(chuàng)建了一個獨立的 $1 后向引用, 一個獨立的原文 1。

當使用被棄用的 e 修飾符時, 這個函數(shù)會轉義一些字符 (即：'、"、 \ 和 NULL) 然后進行后向引用替換。當這些完成后請確保后向引用解析完后沒有單引號或雙引號引起的語法錯誤 (比如： 'strlen(\'$1\')+strlen("$2")')。確保符合 PHP 的 字符串語法，并且符合 eval 語法。因為在完成替換后，引擎會將結果字符串作為 PHP 代碼使用 eval 方式進行評估并將返回值作為最終參與替換的字符串。

subject

要進行搜索和替換的字符串或字符串數(shù)組。

如果 subject 是一個數(shù)組，搜索和替換回在 subject 的每一個元素上進行, 并且返回值也會是一個數(shù)組。

limit

每個模式在每個 subject 上進行替換的最大次數(shù)。默認是 -1(無限)。

count

如果指定，將會被填充為完成的替換次數(shù)。

返回值

如果 subject 是一個數(shù)組，preg_replace() 返回一個數(shù)組，其他情況下返回一個字符串。

如果匹配被查找到，替換后的 subject 被返回，其他情況下返回沒有改變的 subject。如果發(fā)生錯誤，返回 null 。

錯誤／異常

"\e" 會并忽略，并產(chǎn)生 E_WARNING 錯誤。

范例

示例 #1 使用后向引用緊跟數(shù)值原文

<?php
$string = 'April 15, 2003';
$pattern = '/(\w+) (\d+), (\d+)/i';
$replacement = '${1}1,$3';
echo preg_replace($pattern, $replacement, $string);
?>

以上例程會輸出：

April1,2003

示例 #2 preg_replace() 中使用基于索引的數(shù)組

<?php
$string = 'The quick brown fox jumps over the lazy dog.';
$patterns = array();
$patterns[0] = '/quick/';
$patterns[1] = '/brown/';
$patterns[2] = '/fox/';
$replacements = array();
$replacements[2] = 'bear';
$replacements[1] = 'black';
$replacements[0] = 'slow';
echo preg_replace($patterns, $replacements, $string);
?>

以上例程會輸出：

The bear black slow jumps over the lazy dog.

對模式和替換內(nèi)容按 key 進行排序我們可以得到期望的結果。

<?php
ksort($patterns);
ksort($replacements);
echo preg_replace($patterns, $replacements, $string);
?>

以上例程會輸出：

The slow black bear jumps over the lazy dog.

示例 #3 替換一些值

<?php
$patterns = array ('/(19|20)(\d{2})-(\d{1,2})-(\d{1,2})/',
                   '/^\s*{(\w+)}\s*=/');
$replace = array ('\3/\4/\1\2', '$\1 =');
echo preg_replace($patterns, $replace, '{startDate} = 1999-5-27');
?>

以上例程會輸出：

$startDate = 5/27/1999

示例 #4 剝離空白字符

這個例子剝離多余的空白字符

<?php
$str = 'foo   o';
$str = preg_replace('/\s\s+/', ' ', $str);
// 將會改變?yōu)?foo o'
echo $str;
?>

示例 #5 使用參數(shù) count

<?php
$count = 0;

echo preg_replace(array('/\d/', '/\s/'), '*', 'xp 4 to', -1 , $count);
echo $count; //3
?>

以上例程會輸出：

xp***to
3

注釋

注意:

當使用數(shù)組形式的pattern和replacement時, 將會按照key在數(shù)組中出現(xiàn)的順序進行處理. 這不一定和數(shù)組的索引順序一致. 如果你期望使用索引對等方式用replacement對pattern 進行替換, 你可以在調(diào)用preg_replace()之前對兩個數(shù)組各進行一次ksort()排序.

參見