<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<refentry xml:id="function.session-set-cookie-params" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>session_set_cookie_params</refname>

<refpurpose>Set the session cookie parameters</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>session_set_cookie_params</methodname>

<methodparam><type>int</type><parameter>lifetime_or_options</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>path</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>domain</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>secure</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>httponly</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>Alternative signature available as of PHP 7.3.0:</para>

<methodsynopsis>

<type>bool</type><methodname>session_set_cookie_params</methodname>

<methodparam><type>array</type><parameter>lifetime_or_options</parameter></methodparam>

</methodsynopsis>

<para>

Set cookie parameters defined in the &php.ini; file. The effect of this

function only lasts for the duration of the script. Thus, you need to

call <function>session_set_cookie_params</function> for every request and

before <function>session_start</function> is called.

</para>

<para>

This function updates the runtime ini values of the corresponding PHP ini configuration

keys which can be retrieved with the <function>ini_get</function>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>lifetime_or_options</parameter></term>

<listitem>

<para>

When using the first signature, <link linkend="ini.session.cookie-lifetime">lifetime</link> of the

session cookie, defined in seconds.

</para>

<para>

When using the second signature,

an associative <type>array</type> which may have any of the keys

<literal>lifetime</literal>, <literal>path</literal>, <literal>domain</literal>,

<literal>secure</literal>, <literal>httponly</literal> and <literal>samesite</literal>.

The values have the same meaning as described for the parameters with the

same name. The value of the <literal>samesite</literal> element should be

either <literal>Lax</literal> or <literal>Strict</literal>.

If any of the allowed options are not given, their default values are the

same as the default values of the explicit parameters. If the

<literal>samesite</literal> element is omitted, no SameSite cookie

attribute is set.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>path</parameter></term>

<listitem>

<para>

<link linkend="ini.session.cookie-path">Path</link> on the domain where

the cookie will work. Use a single slash ('/') for all paths on the

domain.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>domain</parameter></term>

<listitem>

<para>

Cookie <link linkend="ini.session.cookie-domain">domain</link>, for

example 'www.php.net'. To make cookies visible on all subdomains then

the domain must be prefixed with a dot like '.php.net'.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>secure</parameter></term>

<listitem>

<para>

If &true; cookie will only be sent over

<link linkend="ini.session.cookie-secure">secure</link> connections.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>httponly</parameter></term>

<listitem>

<para>

If set to &true; then PHP will attempt to send the

<link linkend="ini.session.cookie-httponly">httponly</link>

flag when setting the session cookie.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>path</parameter>, <parameter>domain</parameter>,

<parameter>secure</parameter> and <parameter>httponly</parameter> are nullable now.

</entry>

</row>

<row>

<entry>7.3.0</entry>

<entry>

An alternative signature supporting an <parameter>lifetime_or_options</parameter>

&array; has been added. This signature supports also setting of the

SameSite cookie attribute.

</entry>

</row>

<row>

<entry>7.2.0</entry>

<entry>

&return.success; Formerly the function returned <type>void</type>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member>

<link linkend="ini.session.cookie-lifetime">session.cookie_lifetime</link>

</member>

<member>

<link linkend="ini.session.cookie-path">session.cookie_path</link>

</member>

<member>

<link linkend="ini.session.cookie-domain">session.cookie_domain</link>

</member>

<member>

<link linkend="ini.session.cookie-secure">session.cookie_secure</link>

</member>

<member>

<link linkend="ini.session.cookie-httponly">session.cookie_httponly</link>

</member>

<member>

<link linkend="ini.session.cookie-samesite">session.cookie_samesite</link>

</member>

<member><function>session_get_cookie_params</function></member>

</simplelist>

</para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->