Документация для разработчиков
Темная тема

LocalRedirect

Описание и параметры

LocalRedirect(
	string url,
	bool skip_security_check=false,
	string status="302 Found"
);

Выполняет перенаправление браузера на указанную страницу.


Обратите внимание!В функции LocalRedirect в качестве статуса можно установить только те, которые относятся к редиректам, то есть имеют код 3хх. Остальные статусы игнорируются, при попытке их установки будет передан статус 302.


Примечание. Для административной части перенаправление браузера можно использовать только до вывода какого-либо контента (т.е. до подключения файла prolog_admin_after.php или prolog_admin.php). В публичной части - никаких ограничений не накладывается.


Параметры функции

ПараметрОписание С версии
urlURL на который будет перенаправлен браузер. Допустимо использование как относительных адресов, так и адресов ведущих на другие сайты и начинающихся со следующих протоколов: "http://", "https://", "ftp://".
skip_security_checkНеобязательный. Значение true позволяет пропустить проверку модуля безопасности на фишинг.8.0.3
statusНеобязательный. Параметр устанавливает код (статус) в HTTP-заголовке ответа. Например, "301 Moved permanently". Параметр добавлен в версии 8.5.1.8.5.1

События

OnBeforeLocalRedirect - происходит перед редиректом, в обработчик передаётся url.

ПараметрОписание С версии
urlURL на который будет перенаправлен браузер. Допустимо использование как относительных адресов, так и адресов ведущих на другие сайты и начинающихся со следующих протоколов: "http://", "https://", "ftp://".6.5.4
skip_security_checkНеобязательный. Значение true позволяет пропустить проверку модуля безопасности на фишинг.6.5.4
bExternalПризнак того, что передан полный или относительный путь.6.5.4

OnLocalRedirect - происходит во время редиректа после установки заголовка Location. Никакие параметры при этом не возвращаются в обработчик. С версии 6.5.4.


Примеры использования

<?
// полный URL на другой сайт
LocalRedirect("http://www.bitrixsoft.ru/");

// относительный путь от корня текущего сайта
LocalRedirect("/ru/index.php");

// относительный путь к файлу в текущем каталоге текущего сайта
LocalRedirect("index.php");
?>


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
2
Дмитрий
Сообщение не промодерировано, возможны ошибки и неточности.
C точным указанием статуса 301:
Код
LocalRedirect('/url/', false, '301 Moved permanently');
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх