• « session_save_path
  • session_set_save_handler »
  • PHP Manual
  • Функции для работы с сессиями
  • Устанавливает параметры cookie для сессии

session_set_cookie_params

(PHP 4, PHP 5, PHP 7, PHP 8)

session_set_cookie_params — Устанавливает параметры cookie для сессии

Описание

session_set_cookie_params(
    int $lifetime_or_options,
    ?string $path = null,
    ?string $domain = null,
    ?bool $secure = null,
    ?bool $httponly = null
): bool

Альтернативная сигнатура появилась в PHP 7.3.0:

session_set_cookie_params(array $lifetime_or_options): bool
session_set_cookie_params(array $options): bool

Функция устанавливает параметры cookie, которые определили в файле php.ini. Эффект этой функции длится только пока работает скрипт. Поэтому функцию session_set_cookie_params() требуется вызывать для каждого запроса и перед каждым вызовом функции session_start().

Функция обновляет ini-значения времени выполнения, которые соответствуют ini-ключам PHP-конфигурации, которые возвращает функция ini_get().

Список параметров

lifetime_or_options

Первая сигнатура: время жизни сеансового блока данных cookie в секундах.

Вторая сигнатура: ассоциативный массив (array) с произвольным набором ключей из следующего списка: lifetime, path, domain, secure, httponly и samesite. Значения несут тот же смысл, который описали в параметрах с тем же именем. Элемент samesite принимает либо значение Lax, либо значение Strict. Значения разрешённых опций, которые не указали, по умолчанию совпадают со значениями по умолчанию явных параметров. Функция не устанавливает cookie-атрибут SameSite, если элемент samesite не указали.

path

Путь в домене, для которого cookie будет работать. Для всех путей в домене указывают одинарный слеш: «/».

domain

Домен cookie, например «www.php.net». Чтобы каждый поддомен видел cookies, перед именем домена требуется поставить точку, например «.php.net».

secure

Функция будет передавать блоки данных cookies только по защищённым соединениям, если для параметра установили значение true.

httponly

PHP попытается отправить флаг httponly при установке сессионного блока данных cookie, если для параметра установили значение true.

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

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Список изменений

Версия Описание
8.0.0 Параметры path, domain, secure и httponly теперь принимают значение null.
7.3.0 Добавили альтернативную сигнатуру, которая поддерживает массив опций lifetime_or_options. Эта сигнатура поддерживает также установку cookie-атрибута SameSite.
7.2.0 Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка. Раньше функция возвращала тип void.

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

  • session.cookie_lifetime
  • session.cookie_path
  • session.cookie_domain
  • session.cookie_secure
  • session.cookie_httponly
  • session.cookie_samesite
  • session_get_cookie_params() - Возвращает параметры cookie сессии