PHP 7.1.21 Released

session_name

(PHP 4, PHP 5, PHP 7)

session_nameПолучить или установить имя текущей сессии

Описание

string session_name ([ string $name ] )

session_name() возвращает имя текущей сессии. Если задан параметр name, session_name() обновит имя сессии и вернет старое имя сессии.

Если новое имя сессии (name) предоставлено, session_name() изменяет cookie HTTP (и выводит содержимое при включенной опции session.transid). Когда cookie HTTP отправлены, session_name() вызывает ошибку. session_name() необходимо вызывать до session_start() для правильной работы сессии.

Имя сессии сбрасываются на значение по умолчанию, хранящегося в session.name во время запуска запроса. Таким образом, вам нужно вызывать session_name() для каждого запроса (и до session_start()).

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

name

Имя сессии ссылается на имя сессии, которое используется в cookie и URL (например, PHPSESSID ). Оно должно содержать только буквенно-цифровые символы, и должен быть коротким и понятными (например, для пользователей с включенным предупреждением cookie). Если задан параметр name, имя текущей сессии поменяется на него.

Внимание

Имя сессии не может состоять только из цифр, по крайней мере, одна буква должна присутствовать. В противном случае каждый раз будет генерироваться новый идентификатор.

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

Возвращает имя текущей сессии. Если задан параметр name, имя текущей сессии поменяется и будет возвращено старое.

Примеры

Пример #1 Пример использования session_name()

<?php

/* устанавливает имя сессии равным WebsiteID */

$previous_name session_name("WebsiteID");

echo 
"Предыдущее имя сессии: $previous_name<br />";
?>

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

Версия Описание
7.2.0 session_name() проверяет статус сессии, ранее она проверяла только статус cookie. Поэтому старая версия session_name() позволяла вызывать session_name() после session_start(), что могло привести к сбою PHP и неправильному поведению.

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

add a note add a note

User Contributed Notes 8 notes

up
90
Hongliang Qiang
14 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.
up
36
php at wiz dot cx
9 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.
up
27
relsqui at chiliahedron dot com
9 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.
up
16
Joseph Dalrymple
7 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.
up
6
Victor H
2 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!
up
1
tony at marston-home dot demon dot co dot uk
2 months 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
up
1
tony at marston-home dot demon dot co dot uk
2 months 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.
up
-7
slave at codegrunt dot com
13 years ago
One gotcha I have noticed with session_name is that it will trigger a WARNING level error if the cookie or GET/POST variable value has something other than alphanumeric characters in it.  If your site displays warnings and uses PHP sessions this may be a way to enumerate at least some of your scripts: 

http://example.com/foo.php?session_name_here=(bad)

Warning: session_start(): The session id contains invalid characters, valid characters are only a-z, A-Z and 0-9 in /some/path/foo.php on line 666

I did not see anything in the docs suggesting that one had to sanitize the PHP session ID values before opening the session but that appears to be the case.

Unfortunately session_name() always returns true so you have to actually get to the point of assigning variables values before you know whether you have been passed bad session data (as far as I can see).  After the error has been generated in other words.

Cheers
To Top