• « session_save_path
  • session_set_save_handler »
  • PHP Manual
  • Funciones de sesión
  • Modifica los parámetros de la cookie de sesión

session_set_cookie_params

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

session_set_cookie_params — Modifica los parámetros de la cookie de sesión

Descripción

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

Firma alternativa disponible a partir de PHP 7.3.0:

session_set_cookie_params(array $lifetime_or_options): bool

Modifica los parámetros de configuración de la cookie de sesión, que ha sido configurada en el archivo php.ini. El efecto de esta función solo dura durante la ejecución del script actual. Por lo tanto, debe llamarse a session_set_cookie_params() para cada script y antes de la llamada a session_start().

Esta función modifica los parámetros ini correspondientes que pueden ser recuperados mediante ini_get().

Parámetros

lifetime_or_options

Al utilizar la primera firma, la duración de vida de la cookie, en segundos. Ver la directiva lifetime.

Al utilizar la segunda firma, un tableau asociativo que puede tener como claves lifetime, path, domain, secure, httponly y samesite. Los valores tienen la misma significación que los descritos para los parámetros con el mismo nombre. El valor del elemento samesite debe ser Lax o Strict. Si una opción autorizada no es proporcionada, su valor por defecto será idéntico al valor por defecto de los parámetros explícitos. Si el elemento samesite es omitido, entonces el atributo SameSite de la cookie no será definido.

path

La ruta en el dominio donde la cookie será accesible. Utilice una barra simple ('/') para todos los caminos del dominio. Ver la directiva path.

domain

El dominio de la cookie, por ejemplo 'www.php.net'. Para hacer visibles las cookies en todos los subdominios, el dominio debe ser prefijado con un punto, tal como '.php.net'. Ver la directiva domain.

secure

Si true, la cookie solo será enviada en una conexión segura. Ver la directiva secure.

httponly

Si true, PHP intentará enviar la opción httponly durante la configuración de la cookie. Ver la directiva httponly.

Valores devueltos

Devuelve true en caso de éxito o false en caso de error.

Historial de cambios

Versión Descripción
8.0.0 path, domain, secure y httponly ahora son nullable.
7.3.0 Se añadió una firma alternativa que soporta un tableau de lifetime_or_options. Esta firma soporta la definición del atributo SameSite de la cookie.
7.2.0 Devuelve true en caso de éxito o false en caso de error. Anteriormente la función retornaba void.

Ver también

  • session.cookie_lifetime
  • session.cookie_path
  • session.cookie_domain
  • session.cookie_secure
  • session.cookie_httponly
  • session.cookie_samesite
  • session_get_cookie_params() - Lee la configuración del cookie de sesión