session_startStart new or resume existing session
&reftitle.description;
boolsession_startarrayoptions[]session_start creates a session or resumes the
current one based on a session identifier passed via a GET or POST
request, or passed via a cookie.
When session_start is called or when a session auto starts,
PHP will call the open and read session save handlers. These will either be a built-in
save handler provided by default or by PHP extensions (such as SQLite or Memcached); or can be
custom handler as defined by session_set_save_handler.
The read callback will retrieve any existing session data (stored in a special serialized format)
and will be unserialized and used to automatically populate the $_SESSION superglobal when the
read callback returns the saved session data back to PHP session handling.
To use a named session, call
session_name before calling
session_start.
When session.use_trans_sid
is enabled, the session_start function will
register an internal output handler for URL rewriting.
If a user uses ob_gzhandler or similar with
ob_start, the function order is important for
proper output. For example,
ob_gzhandler must be registered before starting the session.
&reftitle.parameters;
options
If provided, this is an associative array of options that will override
the currently set
session configuration directives.
The keys should not include the session. prefix.
In addition to the normal set of configuration directives, a
read_and_close option may also be provided. If set to
&true;, this will result in the session being closed immediately after
being read, thereby avoiding unnecessary locking if the session data
won't be changed.
&reftitle.returnvalues;
This function returns &true; if a session was successfully started,
otherwise &false;.
&reftitle.changelog;
&Version;&Description;7.0.0
The options parameter was added.
5.3.0
If a session fails to start, then &false; is returned.
Previously &true; was returned.
4.3.3
As of PHP 4.3.3, calling session_start
after the session was previously started will result in an
error of level E_NOTICE. Also, the
second session start will simply be ignored.
&reftitle.examples;
A basic session examplepage1.phppage 2';
// Or maybe pass along the session id, if needed
echo ' page 2';
?>
]]>
After viewing page1.php, the second page
page2.php will magically contain the session
data. Read the session reference
for information on propagating
session ids as it, for example, explains what the constant
SID is all about.
page2.php
';
echo $_SESSION['favcolor']; // green
echo $_SESSION['animal']; // cat
echo date('Y m d H:i:s', $_SESSION['time']);
// You may want to use SID here, like we did in page1.php
echo ' page 1';
?>
]]>
Providing options to session_startOverriding the cookie lifetime
86400,
]);
?>
]]>
Reading the session and closing it
86400,
'read_and_close' => true,
]);
]]>
&reftitle.notes;
To use cookie-based sessions, session_start
must be called before outputing anything to the browser.
Use of zlib.output_compression
is recommended instead of ob_gzhandler
This function sends out several HTTP headers depending on the
configuration. See session_cache_limiter to
customize these headers.
&reftitle.seealso;
$_SESSION
The session.auto_start
configuration directive
session_id