Удалить параметры навигации из адреса PageNavigation::clearParams

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

Метод PageNavigation::clearParams удаляет параметры навигации из адреса. Метод нужен, чтобы построить ссылку на первую страницу или на список без навигации, например после смены фильтра.

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

public function clearParams(Web\Uri $uri, $sef)

Параметры

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

Параметр Тип Описание
uri* Bitrix\Main\Web\Uri Задает адрес. Метод меняет этот объект
sef* bool Значение true удаляет сегменты пути ЧПУ, false — параметр запроса

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

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

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

Особенности

В режиме параметра запроса метод вызывает Uri::deleteParams без preserveDots. Поэтому точки и пробелы в именах других параметров адреса станут _, например filter.name станет filter_name.

Примеры

Пример. Код удаляет навигацию из адреса в обоих режимах:

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

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

$nav = new PageNavigation('nav-units');

echo $nav->clearParams(new Uri('/units/list.php?nav-units=page-2&sort=name'), false)->getUri() . "\n";
echo $nav->clearParams(new Uri('/units/list/nav-units/page-2/size-20/?sort=name'), true)->getUri();

Код выведет:

/units/list.php?sort=name
/units/list/?sort=name

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