setcookie() 用於定義一個隨 HTTP 標頭一同發送的 Cookie。由於協定限制,Cookie 必須在腳本輸出任何內容(包含 HTML 標籤、空白字元)之前發送,否則函數會失敗並回傳 FALSE;成功則回傳 TRUE(不代表用戶端一定接受)。
bool setcookie(
string $name,
string $value = "",
int $expire = 0,
string $path = "",
string $domain = "",
bool $secure = false,
bool $httponly = false
)
| 參數 | 說明 | 範例 |
|---|---|---|
name |
Cookie 名稱 | 透過 $_COOKIE['cookiename'] 讀取 |
value |
Cookie 值(儲存在客戶端,勿存敏感資料) | $_COOKIE['cookiename'] 取得值 |
expire |
過期時間(Unix 時間戳),time()+60*60*24*30 表示 30 天後過期;預設 0 為瀏覽器關閉時過期 |
time()+3600 (1小時) |
path |
Cookie 在伺服器端的有效路徑。/ 代表整個網域;/foo/ 僅限該目錄及子目錄 |
'/' 或 '/admin/' |
domain |
Cookie 生效的網域。.example.com 可涵蓋所有子網域;www.example.com 僅限 www 子網域 |
'.example.com' |
secure |
是否僅透過 HTTPS 傳輸。TRUE 時僅在安全連線設置 |
true / false |
httponly |
是否僅供 HTTP 協定存取(防止 JavaScript 存取,緩解 XSS) | true / false |
$value = 'something from somewhere';
setcookie("TestCookie", $value);
setcookie("TestCookie", $value, time()+3600); // 1小時後過期
setcookie("TestCookie", $value, time()+3600, "/~rasmus/", ".utoronto.ca", 1); // 完整參數
// 讀取 Cookie
echo $_COOKIE["TestCookie"];
echo $HTTP_COOKIE_VARS["TestCookie"]; // 舊版全域變數
print_r($_COOKIE); // 除錯用:列出所有 Cookie
注意:Cookie 值在發送時會自動 urlencode,接收時自動解碼。若不想編碼,PHP 5 以上可用 setrawcookie()。
// 將過期時間設為過去
setcookie("TestCookie", "", time() - 3600);
setcookie("TestCookie", "", time() - 3600, "/~rasmus/", ".utoronto.ca", 1);
setcookie("cookie[three]", "cookiethree");
setcookie("cookie[two]", "cookietwo");
setcookie("cookie[one]", "cookieone");
if (isset($_COOKIE['cookie'])) {
foreach ($_COOKIE['cookie'] as $name => $value) {
echo "$name : $value
\n";
}
}
/* 輸出:
three : cookiethree
two : cookietwo
one : cookieone
*/
Cookie 基礎用法不難,關鍵在於掌握 path 路徑設定與 domain 網域設定,才能精確控制作用範圍。