session_name

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

session_name — Liefert und/oder setzt den Namen der aktuellen Session

Beschreibung

session_name(?string $name = null): string|false

session_name() gibt den Namen der aktuellen Session zurück. Falls name angegeben wurde, aktualisiert session_name() den Namen der Session und gibt den alten Namen der Session zurück.

Wird ein neuer Session-Name (name) angegeben, ändert session_name() das HTTP-Cookie (und gibt den Inhalt aus, wenn session.use_trans_sid aktiviert ist). Nachdem das HTTP-Cookie gesendet wurde, erzeugt session_name() ein E_WARNING. session_name() muss vor session_start() aufgerufen werden, damit die Session ordnungsgemäß funktioniert.

Der Session-Name wird auf den Ausgangswert zurückgesetzt, der zu Beginn in session.name gespeichert wurde. Deshalb muss session_name() bei jeder Anfrage aufgerufen werden (und bevor session_start() aufgerufen wurde).

Parameter-Liste

name

Der Session-Name referenziert den Namen der Session, der in Cookies und URLs verwendet wird (z. B. PHPSESSID). Er sollte nur alphanumerische Zeichen enthalten und sollte kurz und beschreibend sein (z. B. für Benutzer mit aktivierter Cookie-Warnung). Wenn name angegeben wird und nicht null ist, wird der Name der aktuellen Session durch dessen Wert ersetzt.

Warnung

Der Session-Name darf nicht nur aus Zahlen bestehen, sondern muss mindestens einen Buchstaben enthalten. Andernfalls wird jedesmal eine neue Session-ID erzeugt.

Rückgabewerte

Gibt den Namen der aktuellen Session zurück. Wird name übergegeben und die Funktion aktualisiert den Session-Namen, wird der Name der alten Session zurückgegeben. Bei einem Fehler wird false zurückgegeben.

Changelog

Version	Beschreibung
8.0.0	`name` ist jetzt nullable (akzeptiert den NULL-Wert).
7.2.0	session_name() prüft den Session-Status; zuvor wurde nur der Cookie-Status geprüft. Somit war es zuvor möglich, dass session_name() nach session_start() aufgerufen wurde, was möglicherweise zum Absturz von PHP und zu anderem Fehlverhalten führen konnte.

Beispiele

Beispiel #1 session_name()-Beispiel

<?php
/* den Session-Namen auf WebsiteID setzen */
$name_vorher = session_name ("WebsiteID");
echo "Der vorhergehende Session-Name war $name_vorher<br />";
?>

Siehe auch

Die Konfigurationsanweisung session.name

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 9 notes

down

144

Hongliang Qiang ¶

20 years ago

This may sound no-brainer: the session_name() function will have no essential effect if you set session.auto_start to "true" in php.ini . And the obvious explanation is the session already started thus cannot be altered before the session_name() function--wherever it is in the script--is executed, same reason session_name needs to be called before session_start() as documented.

I know it is really not a big deal. But I had a quite hard time before figuring this out, and hope it might be helpful to someone like me.

down

php at wiz dot cx ¶

16 years ago

if you try to name a php session "example.com" it gets converted to "example_com" and everything breaks.

don't use a period in your session name.

down

relsqui at chiliahedron dot com ¶

15 years ago

Remember, kids--you MUST use session_name() first if you want to use session_set_cookie_params() to, say, change the session timeout. Otherwise it won't work, won't give any error, and nothing in the documentation (that I've seen, anyway) will explain why.

Thanks to brandan of bildungsroman.com who left a note under session_set_cookie_params() explaining this or I'd probably still be throwing my hands up about it.

down

Joseph Dalrymple ¶

13 years ago

For those wondering, this function is expensive!

On a script that was executing in a consistent 0.0025 seconds, just the use of session_name("foo") shot my execution time up to ~0.09s. By simply sacrificing session_name("foo"), I sped my script up by roughly 0.09 seconds.

down

Victor H ¶

9 years ago

As  Joseph Dalrymple said, adding session_name do slow down a little bit the execution time.
But, what i've observed is that it decreased the fluctuation between requests.
Requests on my script fluctuated between 0,045 and 0,022 seconds. With session_name("myapp"), it goes to 0,050 and 0,045. Not a big deal, but that's a point to note.

For those with problems setting the name, when session.auto_start is set to 1, you need to set the session.name on php.ini!

down

mmulej at gmail dot com ¶

3 years ago

Hope this is not out of php.net noting scope.

session_name('name') must be set before session_start() because the former changes ini settings and the latter reads them. For the same reason session_set_cookie_params($options) must be set before session_start() as well.

I find it best to do the following.

function is_session_started()
{
    if (php_sapi_name() === 'cli')
        return false;

    if (version_compare(phpversion(), '5.4.0', '>='))
        return session_status() === PHP_SESSION_ACTIVE;

    return session_id() !== '';
}
if (!is_session_started()) {
    session_name($session_name);
    session_set_cookie_params($cookie_options);
    session_start();
}

down

-1

tony at marston-home dot demon dot co dot uk ¶

6 years ago

The description that session_name() gets and/or sets the name of the current session is technically wrong. It does nothing but deal with the value originally supplied by the session.name value within the php.ini file.

Thus:-
$name = session_name();
is functionally equivalent to
$name = ini_get('session.name');
and 
session_name('newname);
is functionally equivalent to
ini_set('session.name','newname');

This also means that:
$old_name = session_name('newname');
is functionally equivalent to
$old_name = ini_set('session.name','newname');

The current value of session.name is not attached to a session until session_start() is called. Once session_start() has used session.name to lookup the session_id() in the cookie data the name becomes irrelevant as all further operations on the session data are keyed by the session_id().

Note that changing session.name while a session is currently active will not update the name in any session cookie. The new name does not take effect until the next call to session_start(), and this requires that the current session, which was created with the previous value for session.name, be closed.

down

-3

tony at marston-home dot demon dot co dot uk ¶

6 years ago

The description has recently been modified to contain the statement "When new session name is supplied, session_name() modifies HTTP cookie". This is not correct as session_name() has never modified any cookie data. A change in session.name does not become effective until session_start() is called, and it is session_start() that creates the cookie if it does not already exist.

See the following bug report for details: https://bugs.php.net/bug.php?id=76413

down

-2

descartavel1+php at gmail dot com ¶

1 year ago

Always try to set the prefix for your session name attribute to either `__Host-` or `__Secure-` to benefit from Browsers improved security. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Also, if you have auto_session enabled, you must set this name in session.name in your config (php.ini, htaccess, etc)

＋add a note