在subject中搜索pattern模式的匹配项并替换为replacement。如果指定了limit,则仅替换limit个匹配,如果省略limit或者其值为 -1,则所有的匹配项都会被替换。
replacement可以包含\\n形式或(自 PHP 4.0.4 起)$n形式的逆向引用,首选使用后者。每个此种引用将被替换为与第n个被捕获的括号内的子模式所匹配的文本。n可以从 0 到 99,其中\\0或$0指的是被整个模式所匹配的文本。对左圆括号从左到右计数(从 1 开始)以取得子模式的数目。
对替换模式在一个逆向引用后面紧接着一个数字时(即:紧接在一个匹配的模式后面的数字),不能使用熟悉的\\1符号来表示逆向引用。举例说\\11,将会使 preg_replace() 搞不清楚是想要一个\\1的逆向引用后面跟着一个数字1还是一个\\11的逆向引用。本例中的解决方法是使用\${1}1。这会形成一个隔离的$1逆向引用,而使另一个1只是单纯的文字。
例子 1. 逆向引用后面紧接着数字的用法
|
如果搜索到匹配项,则会返回被替换后的subject,否则返回原来不变的subject。
preg_replace() 的每个参数(除了limit)都可以是一个数组。如果pattern和replacement都是数组,将以其键名在数组中出现的顺序来进行处理。这不一定和索引的数字顺序相同。如果使用索引来标识哪个pattern将被哪个replacement来替换,应该在调用 preg_replace() 之前用 对数组进行排序。
例子 2. 在 preg_replace() 中使用索引数组
|
如果subject是个数组,则会对subject中的每个项目执行搜索和替换,并返回一个数组。
如果pattern和replacement都是数组,则 preg_replace() 会依次从中分别取出值来对subject进行搜索和替换。如果replacement中的值比pattern中的少,则用空字符串作为余下的替换值。如果pattern是数组而replacement是字符串,则对pattern中的每个值都用此字符串作为替换值。反过来则没有意义了。
/e修正符使 preg_replace() 将replacement参数当作 PHP 代码(在适当的逆向引用替换完之后)。提示:要确保replacement构成一个合法的 PHP 代码字符串,否则 PHP 会在报告在包含 preg_replace() 的行中出现语法解析错误。
例子 3. 替换数个值
<?php $patterns = array ("/(19|20)(\d{2})-(\d{1,2})-(\d{1,2})/", "/^\s*{(\w+)}\s*=/");$replace = array ("\\3/\\4/\\1\\2", "$\\1 ="); print preg_replace ($patterns, $replace, "{startDate} = 1999-5-27");?> |
本例将输出:
$startDate = 5/27/1999
例子 4. 使用 /e 修正符
<?php preg_replace ("/(<\/?)(\w+)([^>]*>)/e", "'\\1'.strtoupper('\\2').'\\3'", $html_body);?> |
这将使输入字符串中的所有 HTML 标记变成大写。