preg_replace
Perform a regular expression search and replace
Description
mixedpreg_replace
mixedpattern
mixedreplacement
mixedsubject
intlimit
Searches subject for matches to
pattern and replaces them with
replacement. If
limit is specified, then only
limit matches will be replaced; if
limit is omitted or is -1, then all
matches are replaced.
Replacement may contain references of the form
\\n or (since PHP 4.0.4)
$n, with the latter form
being the preferred one. Every such reference will be replaced by the text
captured by the n'th parenthesized pattern.
n can be from 0 to 99, and
\\0 or $0 refers to the text matched
by the whole pattern. Opening parentheses are counted from left to right
(starting from 1) to obtain the number of the capturing subpattern.
If matches are found, the new subject will
be returned, otherwise subject will be
returned unchanged.
Every parameter to preg_replace (except
limit) can be an array.
If subject is an array, then the search
and replace is performed on every entry of
subject, and the return value is an array
as well.
If pattern and
replacement are arrays, then
preg_replace takes a value from each array
and uses them to do search and replace on
subject. If
replacement has fewer values than
pattern, then empty string is used for the
rest of replacement values. If pattern
is an array and replacement is a string,
then this replacement string is used for every value of
pattern. The converse would not make
sense, though.
/e modifier makes
preg_replace treat the
replacement parameter as PHP code after
the appropriate references substitution is done. Tip: make sure
that replacement constitutes a valid PHP
code string, otherwise PHP will complain about a parse error at
the line containing preg_replace.
Replacing several values
This example will produce:
Using /e modifier
]*>)/e",
"'\\1'.strtoupper('\\2').'\\3'",
$html_body);
]]>
This would capitalize all HTML tags in the input text.
Convert HTML to text
]*?>.*?'si", // Strip out javascript
"'<[\/\!]*?[^<>]*?>'si", // Strip out html tags
"'([\r\n])[\s]+'", // Strip out white space
"'&(quot|#34);'i", // Replace html entities
"'&(amp|#38);'i",
"'&(lt|#60);'i",
"'&(gt|#62);'i",
"'&(nbsp|#160);'i",
"'&(iexcl|#161);'i",
"'&(cent|#162);'i",
"'&(pound|#163);'i",
"'&(copy|#169);'i",
"'(\d+);'e"); // evaluate as php
$replace = array ("",
"",
"\\1",
"\"",
"&",
"<",
">",
" ",
chr(161),
chr(162),
chr(163),
chr(169),
"chr(\\1)");
$text = preg_replace ($search, $replace, $document);
]]>
Parameter limit was added after PHP 4.0.1pl2.
See also preg_match,
preg_match_all, and
preg_split.