preg_replace
Searches subject for matches to pattern and replaces them with replacement .
To match an exact string, rather than a pattern, consider using str_replace() or str_ireplace() instead of this function.
Parameters
The pattern to search for. It can be either a string or an array with strings.
Several PCRE modifiers are also available.
The string or an array with strings to replace. If this parameter is a string and the pattern parameter is an array, all patterns will be replaced by that string. If both pattern and replacement parameters are arrays, each pattern will be replaced by the replacement counterpart. If there are fewer elements in the replacement array than in the pattern array, any extra pattern s will be replaced by an empty string.
replacement may contain references of the form \ n or $ 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. Note that backslashes in string literals may require to be escaped.
When working with a replacement pattern where a backreference is immediately followed by another number (i.e.: placing a literal number immediately after a matched pattern), you cannot use the familiar \1 notation for your backreference. \11 , for example, would confuse preg_replace() since it does not know whether you want the \1 backreference followed by a literal 1 , or the \11 backreference followed by nothing. In this case the solution is to use $1 . This creates an isolated $1 backreference, leaving the 1 as a literal.
When using the deprecated e modifier, this function escapes some characters (namely ‘ , » , \ and NULL) in the strings that replace the backreferences. This is done to ensure that no syntax errors arise from backreference usage with either single or double quotes (e.g. ‘strlen(\’$1\’)+strlen(«$2»)’ ). Make sure you are aware of PHP’s string syntax to know exactly how the interpreted string will look.
The string or an array with strings to search and replace.
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 the subject array is associative, keys will be preserved in the returned value.
The maximum possible replacements for each pattern in each subject string. Defaults to -1 (no limit).
If specified, this variable will be filled with the number of replacements done.
Return Values
preg_replace() returns an array if the subject parameter is an array, or a string otherwise.
If matches are found, the new subject will be returned, otherwise subject will be returned unchanged or null if an error occurred.
Errors/Exceptions
Using the «\e» modifier is an error; an E_WARNING is emitted in this case.
If the regex pattern passed does not compile to a valid regex, an E_WARNING is emitted.
Examples
Example #1 Using backreferences followed by numeric literals
$string = ‘April 15, 2003’ ;
$pattern = ‘/(\w+) (\d+), (\d+)/i’ ;
$replacement = ‘$1,$3’ ;
echo preg_replace ( $pattern , $replacement , $string );
?>?php
The above example will output:
Example #2 Using indexed arrays with preg_replace()
$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 );
?>?php
The above example will output:
The bear black slow jumps over the lazy dog.
By ksorting patterns and replacements, we should get what we wanted.
ksort ( $patterns );
ksort ( $replacements );
echo preg_replace ( $patterns , $replacements , $string );
?>?php
The above example will output:
The slow black bear jumps over the lazy dog.
Example #3 Replacing several values
The above example will output:
Example #4 Strip whitespace
This example strips excess whitespace from a string.
$str = ‘foo o’ ;
$str = preg_replace ( ‘/\s\s+/’ , ‘ ‘ , $str );
// This will be ‘foo o’ now
echo $str ;
?>?php
Example #5 Using the count parameter
echo preg_replace (array( ‘/\d/’ , ‘/\s/’ ), ‘*’ , ‘xp 4 to’ , — 1 , $count );
echo $count ; //3
?>
The above example will output:
Notes
Note:
When using arrays with pattern and replacement , the keys are processed in the order they appear in the array. This is not necessarily the same as the numerical index order. If you use indexes to identify which pattern should be replaced by which replacement , you should perform a ksort() on each array prior to calling preg_replace() .
Note:
When both pattern and replacement are arrays, matching rules will operate sequentially. That is, the second pattern / replacement pair will operate on the string that results from the first pattern / replacement pair, not the original string. If you want to simulate replacements operating in parallel, such as swapping two values, replace one pattern by an intermediary placeholder, then in a later pair replace that intermediary placeholder with the desired replacement.
$p = array( ‘/a/’ , ‘/b/’ , ‘/c/’ );
$r = array( ‘b’ , ‘c’ , ‘d’ );
print_r ( preg_replace ( $p , $r , ‘a’ ));
// prints d
?>?php
See Also
- PCRE Patterns
- preg_quote() — Quote regular expression characters
- preg_filter() — Perform a regular expression search and replace
- preg_match() — Perform a regular expression match
- preg_replace_callback() — Perform a regular expression search and replace using a callback
- preg_split() — Split string by a regular expression
- preg_last_error() — Returns the error code of the last PCRE regex execution
- str_replace() — Replace all occurrences of the search string with the replacement string
- PCRE Functions
- preg_filter
- preg_grep
- preg_last_error_msg
- preg_last_error
- preg_match_all
- preg_match
- preg_quote
- preg_replace_callback_array
- preg_replace_callback
- preg_replace
- preg_split
preg_replace
Выполняет поиск совпадений в строке subject с шаблоном pattern и заменяет их на replacement .
Список параметров
Искомый шаблон. Может быть как строкой, так и массивом строк.
Также доступны некоторые модификаторы PCRE, включая устаревший ‘e‘ (PREG_REPLACE_EVAL), специфичный только для этой функции.
Строка или массив строк для замены. Если этот параметр является строкой, а pattern является массивом, все шаблоны будут заменены этой строкой. Если и pattern и replacement являются массивами, каждый элемент pattern будет заменен соответствующим элементом из replacement . Если массив replacement содержит меньше элементов, чем массив pattern , то все лишние шаблоны из pattern будут заменены пустыми строками.
replacement может содержать ссылки вида \\ n , либо (начиная с PHP 4.0.4) $ n , причем последний вариант предпочтительней. Каждая такая ссылка будет заменена на подстроку, соответствующую n -ой подмаске. n может принимать значения от 0 до 99, причем ссылка \\0 (либо $0) соответствует вхождению всего шаблона. Подмаски нумеруются слева направо, начиная с единицы. Для использования обратного слеша, его необходимо продублировать (строка PHP «\\\\»).
При замене по шаблону с использованием ссылок на подмаски может возникнуть ситуация, когда непосредственно за маской следует цифра (например, установка цифры сразу после совпавшей маски). В таком случае нельзя использовать знакомую нотацию вида \\1 для ссылки на подмаски. Запись, например, \\11, смутит preg_replace() , так как она не сможет понять, хотите ли вы использовать ссылку \\1, за которой следует цифра 1 или же вы хотите просто использовать ссылку \\11, за которой ничего не следует. Это недоразумение можно устранить, если воспользоваться конструкцией \$1, использующей изолированную ссылку $1, и следующую за ней цифру 1.
При использовании устаревшего модификатора e эта функция экранирует некоторые символы (а именно ‘, «, \ и NULL) в строках, замещающих обратные ссылки. Это сделано для удостоверения корректности синтаксиса при использовании обратных ссылок внутри одинарных или двойных кавычек (например, ‘strlen(\’$1\’)+strlen(«$2»)’). Убедитесь, что вы владеете синтаксисом обработки строк PHP для того, чтобы точно осознавать, как будет выглядеть интерпретированная строка.
Строка или массив строк для поиска и замены.
Если subject является массивом, то поиск с заменой осуществляется для каждого элемента массива subject , а возвращаемое значение также будет являться массивом.
Максимально возможное количество замен каждого шаблона для каждой строки subject . По умолчанию равно -1 (без ограничений).
Если указана, то эта переменная будет заполнена количеством произведенных замен.
Возвращаемые значения
preg_replace() возвращает массив, если параметр subject является массивом, иначе возвращается строка.
Если найдены совпадения, возвращается новая версия subject , иначе subject возвращается нетронутым, в случае ошибки возвращается NULL .
Ошибки
При использовании устаревшего модификатора «\e» бросается ошибка уровня E_DEPRECATED .
Список изменений
Версия Описание 5.5.0 Модификатор /e теперь считается устаревшим. Используйте функцию preg_replace_callback() . Смотрите документацию PREG_REPLACE_EVAL с дополнительной информацией и описанием проблем с безопасностью. 5.1.0 Добавлен параметр count Примеры
Пример #1 Использование подмасок, за которыми следует цифра
$string = ‘April 15, 2003’ ;
$pattern = ‘/(\w+) (\d+), (\d+)/i’ ;
$replacement = ‘$1,$3’ ;
echo preg_replace ( $pattern , $replacement , $string );
?>?phpРезультат выполнения данного примера:
Пример #2 Использование массивов с числовыми индексами в качестве аргументов функции preg_replace()
$string = ‘The quick brown fox jumped 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 );
?>?phpРезультат выполнения данного примера:
The bear black slow jumped over the lazy dog.
Отсортировав по ключам шаблоны и замены, получаем желаемый результат:
ksort ( $patterns );
ksort ( $replacements );
echo preg_replace ( $patterns , $replacements , $string );
?>?phpРезультат выполнения данного примера:
The slow black bear jumped over the lazy dog.
Пример #3 Замена по нескольким шаблонам
Результат выполнения данного примера:
Пример #4 Чистка пробелов
Этот пример вычищает лишние пробелы в строке.
$str = ‘foo o’ ;
$str = preg_replace ( ‘/\s\s+/’ , ‘ ‘ , $str );
// Это теперь будет ‘foo o’
echo $str ;
?>?phpПример #5 Использование параметра count
echo preg_replace (array( ‘/\d/’ , ‘/\s/’ ), ‘*’ , ‘xp 4 to’ , — 1 , $count );
echo $count ; //3
?>Результат выполнения данного примера:
Примечания
Замечание:
При использовании массивов в pattern и replacement , ключи обрабатываются в том порядке, в котором они находятся в массиве. Этот порядок не всегда совпадает с числовым порядком индексов. Если вы используете индексы для сопоставления друг с другом нужного pattern и replacement , то вам необходимо прогнать через функцию ksort() оба массива перед использованием preg_replace() .
Смотрите также
- «Регулярные выражения PCRE»
- preg_quote() — Экранирует символы в регулярных выражениях
- preg_filter() — Производит поиск и замену по регулярному выражению
- preg_match() — Выполняет проверку на соответствие регулярному выражению
- preg_replace_callback() — Выполняет поиск по регулярному выражению и замену с использованием callback-функции
- preg_split() — Разбивает строку по регулярному выражению
- preg_last_error() — Возвращает код ошибки выполнения последнего регулярного выражения PCRE