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

set_cookie

CMain::set_cookie(
 string name, 
 string value,
 mixed time = false,
 string folder = "/",
 mixed domain = false,
 bool secure = false,
 bool spread = true,
 mixed name_prefix = false,
 httpOnly=false
)

Устанавливает cookie и при необходимости запоминает параметры установленного cookie для дальнейшего распространения по сайтам с разными доменными именами. Нестатический метод.

Параметры

ПараметрОписание С версии
name Имя cookie переменной.
value Значение cookie переменной.
time Дата в Unix-формате после которой cookie будет считаться истекшим и его значение не будет передаваться от посетителя на сайт.
Необязательный. По умолчанию - cookie устанавливается сроком на 1 год.
folder Каталог веб-сайта для которого cookie будет действителен.
Необязательный. По умолчанию - весь сайт.
domain Домен для которого cookie будет действительным.
Необязательный. По умолчанию - текущий сайт.
secure Флаг secure для устанавливаемого cookie. Если значение "true", то будет установлен как "защищенный", т.е. его значение будет возвращаться на сайт только если посетитель зашел на сайт по протоколу HTTPS.
Необязательный. По умолчанию - "false".
spread Если значение "true", то параметры установленного cookie будут запоминаться для дальнейшего его распространения по доменам (административное меню "Сайты", в настройках сайта - поле "Доменное имя").
name_prefix Префикс имени переменной cookie.
Необязательный. По умолчанию - значение параметра "Имя префикса для названия cookies" в настройках главного модуля (значение данного параметра можно получить с помощью метода:
COption::GetOptionString("main", "cookie_name", "BITRIX_SM")
httpOnly Необязательный. По умолчанию - "false".14.0.1

См. также

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

<?
global $APPLICATION;
// устновим cookie на 2 года, действительного только для каталога /ru/
$APPLICATION->set_cookie("RUSSIAN_VISITOR_ID", 156, time()+60*60*24*30*12*2, "/ru/");
?>


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

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

Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Добавлять комментарии могут только зарегистрированные пользователи. Сообщения для просмотра появляются после модерации.
10
Алексей Шкарупа
Никогда не оставляйте domain = false - это верный путь получить при разных конфигурациях разное поведение.
Если у вас в настройках сайтов прописаны домены - кука будет устанавливаться с указанием домена. В JS такую куку можно будет переопределить только указывая домен (что не всегда удобно).
© «Битрикс», 2001-2018, «1С-Битрикс», 2018
Наверх