preg_replace — Выполняет поиск и замену по регулярному выражению

Назначение preg_replace

preg_replace: Выполняет поиск и замену по регулярному выражению. Справочная сущность относится к разделу «Регулярные выражения PCRE». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается preg_replace

Это процедурная функция раздела «Регулярные выражения PCRE». Её отличают имя preg_replace, контракт «обязательные $pattern, $replacement, $subject; необязательные $limit, $count» и объявленный результат string|array|null; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление preg_replace

Смысловое направление preg_replace — «изменение состояния». В прикладном коде до вызова сохраните ожидаемое исходное состояние, после — проверьте фактическое изменение. Контрольный набор для этой операции: проверьте идемпотентность повтора и конфликт параллельного обновления. Такой акцент отделяет preg_replace от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура preg_replace

Структурная запись: string|array|null preg_replace(string|array $pattern, string|array $replacement, string|array $subject, int $limit = -1, int $count = null). В ней 5 параметров: обязательные $pattern, $replacement, $subject; необязательные $limit, $count. Результат объявлен как string|array|null; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры preg_replace

Порядок и роли аргументов по сигнатуре: 1. $pattern — string|array, обязателен; 2. $replacement — string|array, обязателен; 3. $subject — string|array, обязателен; 4. $limit — int, необязателен, default -1; 5. $count — int, необязателен, default null.

Контроль входных данных для preg_replace

1) string|array $pattern — обязательный: испытайте корректный, пустой и синтаксически ошибочный шаблон или формат. 2) string|array $replacement — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 3) string|array $subject — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 4) int $limit — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 5) int $count — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры.

Результат preg_replace

preg_replace объявляет результат типа string|array|null. В результате preg_replace присутствует null. Обрабатывайте его отдельной веткой и не используйте нестрогое сравнение, если другие допустимые значения могут быть пустыми.

Проверочный сценарий для preg_replace

Убедитесь, что раздел «Регулярные выражения PCRE» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором string|array $pattern, string|array $replacement, string|array $subject. Затем отдельно добавьте необязательные параметры int $limit=-1, int $count=null, чтобы увидеть влияние значений по умолчанию. Для профиля «сопоставление с шаблоном» важно ограничить сложность шаблона для недоверенного ввода; негативный сценарий должен проверить отсутствие совпадения, пустую строку и ошибочный шаблон.

Интеграция preg_replace в проект

Проверку доступности preg_replace и преобразование входных значений разместите у границы модуля «Регулярные выражения PCRE». Для профиля «сопоставление с шаблоном» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция preg_replace не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика preg_replace

Сначала запишите точную сигнатуру string|array|null preg_replace(string|array $pattern, string|array $replacement, string|array $subject, int $limit = -1, int $count = null) и фактические типы переданных значений. Затем подтвердите загрузку расширения «Регулярные выражения PCRE» в той же среде, где выполняется preg_replace. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «сопоставление с шаблоном» применяйте отдельный негативный тест: проверить отсутствие совпадения, пустую строку и ошибочный шаблон. В production-коде важно ограничить сложность шаблона для недоверенного ввода. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать preg_replace

Выбор preg_replace оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «Регулярные выражения PCRE»; 2) сигнатура содержит 5 аргументов: обязательных 3, необязательных 2; 3) вызывающему коду нужен результат string|array|null и действие «изменение состояния». Для профиля «сопоставление с шаблоном» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с preg_quote: у него другое назначение, владелец или набор входных данных.

Сравнение preg_replace с соседними API

Для preg_replace базовый ориентир: выполняет поиск и замену по регулярному выражению; обязательные $pattern, $replacement, $subject; необязательные $limit, $count; результат string|array|null. Сопоставление с опубликованными соседями: preg_quote: экранирует символы в регулярных выражениях; вход — обязательные $str; необязательные $delimiter; результат — string. preg_filter: производит поиск и замену по регулярному выражению; вход — обязательные $pattern, $replacement, $subject; необязательные $limit, $count; результат — string|array|null. preg_match: выполняет проверку на соответствие регулярному выражению; вход — обязательные $pattern, $subject; необязательные $matches, $flags, $offset; результат — int|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

preg_replace сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для preg_replace.

Связанные материалы