Source of: /manual/en/function.session-set-cookie-params.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.session.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.session-set-cookie-params.php',
1 => 'session_set_cookie_params',
),
'up' =>
array (
0 => 'ref.session.php',
1 => 'Session Functions',
),
'prev' =>
array (
0 => 'function.session-save-path.php',
1 => 'session_save_path',
),
'next' =>
array (
0 => 'function.session-set-save-handler.php',
1 => 'session_set_save_handler',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.session-set-cookie-params" class="refentry">
<div class="refnamediv">
<h1 class="refname">session_set_cookie_params</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">session_set_cookie_params</span> — <span class="dc-title">Set the session cookie parameters</span></p>
</div>
<a name="function.session-set-cookie-params.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><b>session_set_cookie_params</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$lifetime</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$path</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$domain</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$secure</tt><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$httponly</tt><span class="initializer"> = false</span></span>
]]]] )</div>
<p class="para rdfs-comment">
Set cookie parameters defined in the <var class="filename">php.ini</var> file. The effect of this
function only lasts for the duration of the script. Thus, you need to
call <b>session_set_cookie_params()</b> for every request and
before <a href="function.session-start.php" class="function">session_start()</a> is called.
</p>
</div>
<a name="function.session-set-cookie-params.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">lifetime</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
<a href="session.configuration.php#ini.session.cookie-lifetime" class="link">Lifetime</a> of the
session cookie, defined in seconds.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">path</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
<a href="session.configuration.php#ini.session.cookie-path" class="link">Path</a> on the domain where
the cookie will work. Use a single slash ('/') for all paths on the
domain.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">domain</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Cookie <a href="session.configuration.php#ini.session.cookie-domain" class="link">domain</a>, for
example 'www.php.net'. To make cookies visible on all subdomains then
the domain must be prefixed with a dot like '.php.net'.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">secure</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
If <b><tt class="constant">TRUE</tt></b> cookie will only be sent over
<a href="session.configuration.php#ini.session.cookie-secure" class="link">secure</a> connections.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">httponly</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
If set to <b><tt class="constant">TRUE</tt></b> then PHP will attempt to send the
<a href="session.configuration.php#ini.session.cookie-httponly" class="link">httponly</a>
flag when setting the session cookie.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.session-set-cookie-params.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<a name="function.session-set-cookie-params.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">5.2.0</td>
<td align="left">
The <i><tt class="parameter">httponly</tt></i>
parameter was added.
</td>
</tr>
<tr valign="middle">
<td align="left">4.0.4</td>
<td align="left">
The <i><tt class="parameter">secure</tt></i>
parameter was added.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.session-set-cookie-params.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member">
<a href="session.configuration.php#ini.session.cookie-lifetime" class="link">session.cookie_lifetime</a>
</li>
<li class="member">
<a href="session.configuration.php#ini.session.cookie-domain" class="link">session.cookie_domain</a>
</li>
<li class="member">
<a href="session.configuration.php#ini.session.cookie-secure" class="link">session.cookie_secure</a>
</li>
<li class="member">
<a href="session.configuration.php#ini.session.cookie-httponly" class="link">session.cookie_httponly</a>
</li>
<li class="member"><a href="function.session-get-cookie-params.php" class="function" rel="rdfs-seeAlso">session_get_cookie_params()</a> - Get the session cookie parameters</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
