preg_replace

(PHP 4, PHP 5)

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

說明

mixed preg_replace ( mixed $pattern , mixed $replacement , mixed $subject [, int $limit = -1 [, int &$count ]] )

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

參數

pattern

要搜索的模式. 可以使一個字符串或字符串數組.

可以使用一些PCRE修飾符, 包括'e'(PREG_REPLACE_EVAL), 可以為這個函數指定.

replacement

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

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

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

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

subject

要進行搜索和替換的字符串或字符串數組.

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

limit

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

count

如果指定, 將會被填充為完成的替換次數.

返回值

如果subject是一個數組, preg_replace()返回一個數組, 其他情況下返回一個字符串.

如果匹配被查找到, 替換后的subject被返回, 其他情況下 返回沒有改變的subject. 如果發生錯誤, 返回NULL .

更新日志

版本 說明

5.1.0 增加參數count.

4.0.4 增加replacement參數中的'$n'用法.

4.0.2 增加了參數limit

范例

Example #1 使用后向引用緊跟數值原文

<?php

$string = 'April 15, 2003';

$pattern = '/(w+) (d+), (d+)/i';

$replacement = '${1}1,$3';

echo preg_replace($pattern, $replacement, $string);
?>

以上例程會輸出：

April1,2003