Удалить параметры запроса Uri::deleteParams

Модуль: main — подключать отдельно не нужно

Доступно с версии: 15.5.10

Метод Uri::deleteParams удаляет параметры из строки запроса по именам. Метод меняет сам объект.

Сигнатура метода в классе Bitrix\Main\Web\Uri:

public function deleteParams(array $params, $preserveDots = false)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
params* string[] Задает имена параметров, например ['page', 'sort']. Если параметра нет в адресе, метод его пропускает
preserveDots bool Значение true сохраняет точки и пробелы в именах параметров. По умолчанию — false

Сигнатура PHP объявляет только тип params.

Возвращаемое значение

Метод возвращает тот же объект Uri.

Особенности

  • Без preserveDots функция parse_str заменяет точки и пробелы в именах на _. Тогда метод не найдет параметр filter.name и перепишет остальные имена с точками. Для таких имен передайте true.
  • Метод собирает строку запроса заново, как addParams.

Примеры

Пример. Код удаляет параметр с точкой в имени:

<?php
use Bitrix\Main\Web\Uri;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$uri = new Uri('/units/list.php?filter.name=kg&page=2');

echo (clone $uri)->deleteParams(['filter.name'])->getUri() . "\n";
echo (clone $uri)->deleteParams(['filter.name'], true)->getUri();

Код выведет:

/units/list.php?filter_name=kg&page=2
/units/list.php?page=2

Смотрите также