Source of: /manual/en/function.session-get-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-get-cookie-params.php',
1 => 'session_get_cookie_params',
),
'up' =>
array (
0 => 'ref.session.php',
1 => 'Session Functions',
),
'prev' =>
array (
0 => 'function.session-encode.php',
1 => 'session_encode',
),
'next' =>
array (
0 => 'function.session-id.php',
1 => 'session_id',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.session-get-cookie-params" class="refentry">
<div class="refnamediv">
<h1 class="refname">session_get_cookie_params</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">session_get_cookie_params</span> — <span class="dc-title">Get the session cookie parameters</span></p>
</div>
<a name="function.session-get-cookie-params.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>session_get_cookie_params</b></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Gets the session cookie parameters.
</p>
</div>
<a name="function.session-get-cookie-params.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array with the current session cookie information, the array
contains the following items:
</p><ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<a href="session.configuration.php#ini.session.cookie-lifetime" class="link">"lifetime"</a> - The
lifetime of the cookie in seconds.
</span>
</li>
<li class="listitem">
<span class="simpara">
<a href="session.configuration.php#ini.session.cookie-path" class="link">"path"</a> - The path where
information is stored.
</span>
</li>
<li class="listitem">
<span class="simpara">
<a href="session.configuration.php#ini.session.cookie-domain" class="link">"domain"</a> - The domain
of the cookie.
</span>
</li>
<li class="listitem">
<span class="simpara">
<a href="session.configuration.php#ini.session.cookie-secure" class="link">"secure"</a> - The cookie
should only be sent over secure connections.
</span>
</li>
<li class="listitem">
<span class="simpara">
<a href="session.configuration.php#ini.session.cookie-httponly" class="link">"httponly"</a> - The
cookie can only be accessed through the HTTP protocol.
</span>
</li>
</ul><p>
</p>
</div>
<a name="function.session-get-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 "httponly" entry was added in the returned array.
</td>
</tr>
<tr valign="middle">
<td align="left">4.0.4</td>
<td align="left">
The "secure" entry was added in the returned array.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.session-get-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-path" class="link">session.cookie_path</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-set-cookie-params.php" class="function" rel="rdfs-seeAlso">session_set_cookie_params()</a> - Set the session cookie parameters</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
