定義和用法
setcookie() 函數向客戶端發送一個 HTTP cookie。
cookie 是由服務器發送到瀏覽器的變量。cookie 通常是服務器嵌入到用戶計算機中的小文本文件。每當同一臺計算機通過瀏覽器請求頁面時,就會發送這個 cookie。
cookie 的名稱自動指定爲相同名稱的變量。例如,如果被髮送的 cookie 名爲 "user",則會自動創建一個名爲 $user 的變量,包含 cookie 的值。
必須在任何其他輸出發送到客戶端前對 cookie 進行賦值。
如果成功,該函數返回 TRUE。如果失敗則返回 FALSE。
語法
參數 | 描述 |
---|---|
name | 必需。規定 cookie 的名稱。 |
value | 必需。規定 cookie 的值。 |
expire |
可選。規定 cookie 的過期時間。
time()+3600*24*30 將設置 cookie 的過期時間爲 30 天。如果這個參數沒有設置,那麼 cookie 將在 session 結束後(即瀏覽器關閉時)自動失效。 |
path |
可選。規定 cookie 的服務器路徑。
如果路徑設置爲 "/",那麼 cookie 將在整個域名內有效.如果路徑設置爲 "/test/",那麼 cookie 將在 test 目錄下及其所有子目錄下有效。默認的路徑值是 cookie 所處的當前目錄。 |
domain |
可選。規定 cookie 的域名。
爲了讓 cookie 在 example.com 的所有子域名中有效,您需要把 cookie 的域名設置爲 ".example.com"。當您把 cookie 的域名設置爲 www.example.com 時,cookie 僅在 www 子域名中有效。 |
secure | 可選。規定是否需要在安全的 HTTPS 連接來傳輸 cookie。如果 cookie 需要在安全的 HTTPS 連接下傳輸,則設置爲 TRUE。默認是 FALSE。 |
提示和註釋
提示:可以通過 $HTTP_COOKIE_VARS["user"] 或 $_COOKIE["user"] 來訪問名爲 "user" 的 cookie 的值。
註釋:在發送 cookie 時,cookie 的值會自動進行 URL 編碼。接收時會自動進行 URL 解碼。如果您不需要這樣,可以使用 setrawcookie() 代替。
實例 1
設置併發送 cookie:
$value = "my cookie value";
// send a simple cookie
setcookie("TestCookie",$value);
?>
<html>
<body>
...
...
$value = "my cookie value";
// send a cookie that expires in 24 hours
setcookie("TestCookie",$value, time()+3600*24);
?>
<html>
<body>
...
...
實例 2
檢索 cookie 值的不同方法(在 cookie 設置之後):
<body>
<?php
// Print individual cookies
echo $_COOKIE["TestCookie"];
echo "<br />";
echo $HTTP_COOKIE_VARS["TestCookie"];
echo "<br />";
// Print all cookies
print_r($_COOKIE);
?>
</body>
</html>
上面的代碼將輸出:
my cookie value
Array ([TestCookie] => my cookie value)
實例 3
通過把失效日期設置爲過去的日期/時間,刪除一個 cookie:
// Set the expiration date to one hour ago
setcookie ("TestCookie", "", time() - 3600);
?>
<html>
<body>
...
...
實例 4
創建一個數組 cookie:
setcookie("cookie[three]","cookiethree");
setcookie("cookie[two]","cookietwo");
setcookie("cookie[one]","cookieone");
// print cookies (after reloading page)
if (isset($_COOKIE["cookie"]))
{
foreach ($_COOKIE["cookie"] as $name => $value)
{
echo "$name : $value <br />";
}
}
?>
<html>
<body>
...
...
上面的代碼將輸出:
two : cookietwo
one : cookieone