<HTML
><HEAD
><TITLE
>setcookie</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="HTTP functions"
HREF="ref.http.html"><LINK
REL="PREVIOUS"
TITLE="header"
HREF="function.header.html"><LINK
REL="NEXT"
TITLE="Hyperwave functions"
HREF="ref.hyperwave.html"></HEAD
><BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.header.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="ref.hyperwave.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.setcookie"
>setcookie</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN10256"
></A
>setcookie -- Send a cookie</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN10259"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><P
></P
><CODE
CLASS="FUNCDEF"
>int setcookie</CODE
>(string name, string value, int expire, string path, string domain, int secure);<P
></P
></DIV
><P
> <B
CLASS="function"
>setcookie()</B
> defines a cookie to be sent along
with the rest of the header information. Cookies must be sent
<I
CLASS="emphasis"
>before</I
> any other headers are sent (this is a
restriction of cookies, not PHP). This requires you to place
calls to this function before any <TT
CLASS="literal"
><html></TT
> or
<TT
CLASS="literal"
><head></TT
> tags.
</P
><P
> All the arguments except the <TT
CLASS="parameter"
><I
>name</I
></TT
> argument
are optional. If only the name argument is present, the cookie
by that name will be deleted from the remote client. You may
also replace any argument with an empty string
(<I
CLASS="emphasis"
>""</I
>) in order to skip that
argument. The <TT
CLASS="parameter"
><I
>expire</I
></TT
> and
<TT
CLASS="parameter"
><I
>secure</I
></TT
> arguments are integers and cannot
be skipped with an empty string. Use a zero
(<I
CLASS="emphasis"
>0</I
>) instead. The
<TT
CLASS="parameter"
><I
>expire</I
></TT
> argument is a regular Unix time
integer as returned by the <A
HREF="function.time.html"
><B
CLASS="function"
>time()</B
></A
> or
<A
HREF="function.mktime.html"
><B
CLASS="function"
>mktime()</B
></A
> functions. The
<TT
CLASS="parameter"
><I
>secure</I
></TT
> indicates that the cookie should
only be transmitted over a secure HTTPS connection.
</P
><P
>
Common Pitfalls:
</P
><P
> Cookies will not become visible until the next loading of a page that
the cookie should be visible for.
</P
><P
> Multiple calls to <B
CLASS="function"
>setcookie()</B
> in the same
script will be performed in reverse order. If you are trying to
delete one cookie before inserting another you should put the
insert before the delete.
</P
><P
> Some examples follow:
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><P
><B
>Example 1. <B
CLASS="function"
>setcookie()</B
> examples</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> 1
2 setcookie ("TestCookie", "Test Value");
3 setcookie ("TestCookie", $value,time()+3600); /* expire in 1 hour */
4 setcookie ("TestCookie", $value,time()+3600, "/~rasmus/", ".utoronto.ca", 1);
5 </PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
</P
><P
> Note that the value portion of the cookie will automatically be
urlencoded when you send the cookie, and when it is received, it
is automatically decoded and assigned to a variable by the same
name as the cookie name. To see the contents of our test
cookie in a script, simply use one of the following examples:
<DIV
CLASS="informalexample"
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> 1
2 echo $TestCookie;
3 echo $HTTP_COOKIE_VARS["TestCookie"];
4 </PRE
></TD
></TR
></TABLE
><P
></P
></DIV
>
</P
><P
> You may also set array cookies by using array notation in the
cookie name. This has the effect of setting as many cookies as
you have array elements, but when the cookie is received by your
script, the values are all placed in an array with the cookie's
name:
<DIV
CLASS="informalexample"
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> 1
2 setcookie ("cookie[three]", "cookiethree");
3 setcookie ("cookie[two]", "cookietwo");
4 setcookie ("cookie[one]", "cookieone");
5 if (isset ($cookie)) {
6 while (list ($name, $value) = each ($cookie)) {
7 echo "$name == $value<br>\n";
8 }
9 }
10 </PRE
></TD
></TR
></TABLE
><P
></P
></DIV
>
</P
><P
> For more information on cookies, see Netscape's cookie
specification at <A
HREF="http://www.netscape.com/newsref/std/cookie_spec.html"
TARGET="_top"
>http://www.netscape.com/newsref/std/cookie_spec.html</A
>.
</P
><P
> Microsoft Internet Explorer 4 with Service Pack 1 applied does
not correctly deal with cookies that have their path parameter
set.
</P
><P
> Netscape Communicator 4.05 and Microsoft Internet Explorer 3.x
appear to handle cookies incorrectly when the path and time
are not set.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.header.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="ref.hyperwave.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>header</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.http.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Hyperwave functions</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
ebb1914cf182a88528b4547490db1dd8
>
files
>
1443
