- PHP Manual
- Session-Funktionen
- Setzt die Session-Cookie-Parameter
session_set_cookie_params
(PHP 4, PHP 5, PHP 7, PHP 8)
session_set_cookie_params — Setzt die Session-Cookie-Parameter
Beschreibung
int
$lifetime_or_options
,?string
$path
= null
,?string
$domain
= null
,?bool
$secure
= null
,?bool
$httponly
= null
): bool
Alternative Signatur, verfügbar ab PHP 7.3.0:
$lifetime_or_options
): boolSetzen der Cookie-Parameter, die in der php.ini definiert sind. Diese Funktion wirkt sich nur für die Dauer des Scripts aus. Folglich müssen Sie session_set_cookie_params() bei jeder Anfrage und noch vor dem Aufruf von session_start() aufrufen.
Diese Funktion aktualisiert die Laufzeitwerte der zugehörigen Konfigurationsschlüssel, die mittels ini_get() abgefragt werden können.
Parameter-Liste
-
lifetime_or_options
-
Bei Verwendung der ersten Signatur, die Lebensdauer des Session-Cookies in Sekunden.
Ein assoziatives Array, das die Schlüssel
lifetime
,path
,domain
,secure
,httponly
undsamesite
enthalten kann. Die Werte haben dieselbe Bedeutung wie für die gleichnamigen Parameter beschrieben. Der Wert dessamesite
-Elements sollte entwederLax
oderStrict
sein. Ist eine der erlaubten Optionen nicht angegeben, dann ist ihr Standardwert derselbe wie für den expliziten Parameter. Wird dassamesite
-Element nicht angegeben, dann wird das SameSite-Attribut des Cookies nicht gesetzt. -
path
-
Der Pfad der Domain, in dem das Cookie zur Verfügung steht. Mit einem einfachen Schrägstrich ('/') gilt es für alle Pfade der Domain.
-
domain
-
Die Cookie-Domain, z.B. 'www.php.net'. Damit die Cookies auf allen Subdomains zur Verfügung stehen, muss der Domain wie in '.php.net' ein Punkt vorangestellt werden.
-
secure
-
Falls auf
true
gesetzt, wird das Cookie nur über sichere Verbindungen gesendet. -
httponly
-
Falls auf
true
gesetzt, versucht PHP das httponly-Flag zu senden wenn das Session-Cookie gesetzt wird.
Rückgabewerte
Gibt bei Erfolg true
zurück. Bei einem Fehler wird false
zurückgegeben.
Changelog
Version | Beschreibung |
---|---|
8.0.0 |
path , domain ,
secure und httponly sind
jetzt Nullable-Typen.
|
7.3.0 |
Eine alternative Signatur, die ein options
Array unterstützt, wurde hinzugefügt. Diese Signatur unterstützt
ebenfalls das Setzen des SameSite-Cookie-Attributs.
|
7.2.0 |
Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben. Zuvor gab die Funktion void zurück.
|
Siehe auch
- session.cookie_lifetime
- session.cookie_path
- session.cookie_domain
- session.cookie_secure
- session.cookie_httponly
- session.cookie_samesite
- session_get_cookie_params() - Liefert die Parameter des Session-Cookies