(PHP 4, PHP 5, PHP 7, PHP 8)
preg_replace — 執行一個(gè)正則表達式的搜索和替換
$pattern
,$replacement
,$subject
,$limit
= -1,&$count
= null
搜索 subject
中匹配 pattern
的部分,以
replacement
進(jìn)行替換。
pattern
要搜索的模式??梢允挂粋€(gè)字符串或字符串數組。
可以使用一些 PCRE 修飾符。
replacement
用于替換的字符串或字符串數組。如果這個(gè)參數是一個(gè)字符串,并且 pattern
是一個(gè)數組,那么所有的模式都使用這個(gè)字符串進(jìn)行替換。如果 pattern
和 replacement
都是數組,每個(gè) pattern
使用 replacement
中對應的元素進(jìn)行替換。如果
replacement
中的元素比 pattern
中的少,多出來(lái)的
pattern
使用空字符串進(jìn)行替換。
replacement
中可以包含后向引用 \\n
或 $n
,語(yǔ)法上首選后者。 每個(gè)這樣的引用將被匹配到的第
n 個(gè)捕獲子組捕獲到的文本替換。 n 可以是0-99,\\0
和 $0
代表完整的模式匹配文本。捕獲子組的序號計數方式為:代表捕獲子組的左括號從左到右, 從1開(kāi)始數。如果要在
replacement
中使用反斜線(xiàn),必須使用 4 個(gè)("\\\\"
,譯注:因為這首先是 PHP
的字符串,經(jīng)過(guò)轉義后,是兩個(gè),再經(jīng)過(guò)正則表達式引擎后才被認為是一個(gè)原文反斜線(xiàn))。
當在替換模式下工作并且后向引用后面緊跟著(zhù)需要是另外一個(gè)數字 (比如:在一個(gè)匹配模式后緊接著(zhù)增加一個(gè)原文數字),不能使用
\\1
這樣的語(yǔ)法來(lái)描述后向引用。比如,\\11
將會(huì )使preg_replace()
不能理解你希望的是一個(gè) \\1
后向引用緊跟一個(gè)原文 1
,還是一個(gè)
\\11
后向引用后面不跟任何東西。 這種情況下解決方案是使用 ${1}1
。這創(chuàng )建了一個(gè)獨立的
$1
后向引用, 一個(gè)獨立的原文 1
。
當使用被棄用的 e
修飾符時(shí), 這個(gè)函數會(huì )轉義一些字符 (即:'
、"
、
\
和 NULL) 然后進(jìn)行后向引用替換。當這些完成后請確保后向引用解析完后沒(méi)有單引號或雙引號引起的語(yǔ)法錯誤 (比如:
'strlen(\'$1\')+strlen("$2")'
)。確保符合 PHP 的
字符串語(yǔ)法,并且符合 eval 語(yǔ)法。因為在完成替換后,引擎會(huì )將結果字符串作為 PHP 代碼使用
eval 方式進(jìn)行評估并將返回值作為最終參與替換的字符串。
subject
要進(jìn)行搜索和替換的字符串或字符串數組。
如果 subject
是一個(gè)數組,搜索和替換回在
subject
的每一個(gè)元素上進(jìn)行, 并且返回值也會(huì )是一個(gè)數組。
limit
每個(gè)模式在每個(gè) subject
上進(jìn)行替換的最大次數。默認是
-1
(無(wú)限)。
count
如果指定,將會(huì )被填充為完成的替換次數。
如果 subject
是一個(gè)數組,preg_replace()
返回一個(gè)數組,其他情況下返回一個(gè)字符串。
如果匹配被查找到,替換后的 subject
被返回,其他情況下返回沒(méi)有改變的
subject
。如果發(fā)生錯誤,返回 null
。
"\e" 會(huì )并忽略,并產(chǎn)生
E_WARNING
錯誤。
示例 #1 使用后向引用緊跟數值原文
<?php
$string = 'April 15, 2003';
$pattern = '/(\w+) (\d+), (\d+)/i';
$replacement = '${1}1,$3';
echo preg_replace($pattern, $replacement, $string);
?>
以上例程會(huì )輸出:
April1,2003
示例 #2 preg_replace() 中使用基于索引的數組
<?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);
?>
以上例程會(huì )輸出:
The bear black slow jumps over the lazy dog.
對模式和替換內容按 key 進(jìn)行排序我們可以得到期望的結果。
<?php
ksort($patterns);
ksort($replacements);
echo preg_replace($patterns, $replacements, $string);
?>
以上例程會(huì )輸出:
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');
?>
以上例程會(huì )輸出:
$startDate = 5/27/1999
示例 #4 剝離空白字符
這個(gè)例子剝離多余的空白字符
<?php
$str = 'foo o';
$str = preg_replace('/\s\s+/', ' ', $str);
// 將會(huì )改變?yōu)?foo o'
echo $str;
?>
示例 #5 使用參數 count
<?php
$count = 0;
echo preg_replace(array('/\d/', '/\s/'), '*', 'xp 4 to', -1 , $count);
echo $count; //3
?>
以上例程會(huì )輸出:
xp***to 3
注意:
當使用數組形式的
pattern
和replacement
時(shí), 將會(huì )按照key在數組中出現的順序進(jìn)行處理. 這不一定和數組的索引順序一致. 如果你期望使用索引對等方式用replacement
對pattern
進(jìn)行替換, 你可以在調用preg_replace()之前對兩個(gè)數組各進(jìn)行一次ksort()排序.