PHP setcookie() 関数

❮ PHP HTTP リファレンス

次の例では、"John Doe" という値を持つ "user" という名前のクッキーを作成します。クッキーは30日後に期限が切れます(86400 * 30)。 "/" は、クッキーが web サイト全体で使用可能であることを意味します(そうしたくない場合は、好きなディレクトリを選択してください)。

次に、クッキー "user" の値を取得します(グローバル変数 $_COOKIE を使用します)。また、isset()関数を使用して、 クッキーが設定されているかどうかも調べます:

<!DOCTYPE html>
<?php
$cookie_name = "user";
$cookie_value = "John Doe";
setcookie($cookie_name, $cookie_value, time() + (86400 * 30), "/"); // 86400 = 1 day
?>
<html>
<body>

<?php
if(!isset($_COOKIE[$cookie_name])) {
    echo "Cookie named '" . $cookie_name . "' is not set!";
} else {
    echo "Cookie '" . $cookie_name . "' is set!<br>";
    echo "Value is: " . $_COOKIE[$cookie_name];
}
?>

</body>
</html>
例の実行 »

定義と用法

setcookie() 関数は、その他のHTTPヘッダと共に送信するクッキーを定義します。

クッキーは、よくユーザを識別するために使われます。クッキーは、サーバがユーザのコンピュータに埋め込む小さなファイルです。 同じコンピュータがブラウザを使用してページをリクエストするたびに、クッキーも一緒に送信されてきます。 PHP を使用することで、クッキー値の作成と取得が可能です。

クッキー名は、同じ名前の変数に自動的に割り当てられます。例えば、"user" という名前のクッキーが送信された場合、 クッキー値を持つ変数 $user が自動的に作成されます。

注: setcookie()関数は、<html> タグの前に現れなければなりません。

注: クッキーの値は、クッキーを送信するときに自動的にURLエンコードされ、受信時に自動的にデコードされます (URLエンコードをしなくない場合は、setrawcookie()を使用してください)。

構文

setcookie(name,value,expire,path,domain,secure,httponly);

パラメータ 説明
name 必須。クッキー名を指定する
value 任意。クッキーの値を指定する
expire 任意。クッキーの有効期限を指定する。有効期限が30日の場合は、値を time()+86400*30 に設定する。 このパラメータを省略するか 0 に設定すると、セッション終了時(ブラウザをクローズしたとき)にクッキーが期限切れになる。デフォルトは 0
path 任意。クッキーのサーバパスを指定する。"/" を設定すると、クッキーはドメイン全体で利用可能になる。 "/php/" を設定すると、クッキーは php ディレクトリと php 配下のすべてのサブディレクトリ内でのみ利用可能になる。 デフォルト値は、クッキーが設定されている現在のディレクトリになる
domain 任意。クッキーのドメイン名を指定する。example.comのすべてのサブドメインでクッキーを利用できるようにするには、domainに "example.com"を設定する。 www.example.com を設定すると、www サブドメインでのみ利用可能になる
secure 任意。クッキーをセキュアな HTTPS 接続でのみ送信するかどうかを指定する。 TRUEは、セキュアな接続が存在する場合にのみクッキーを設定する。デフォルトは FALSE
httponly 任意。TRUE を設定すると、クッキーはHTTPプロトコルを通してのみアクセスできる(スクリプト言語ではクッキーにアクセスできなくなる)。 この設定は、XSS攻撃による個人情報の盗難を減らすのに役立ちます。デフォルトは FALS

技術内容
返り値: 成功した場合は TRUEを、失敗した場合は FALSEを返します
PHP バージョン: 4+
PHP 変更歴 PHP 5.5 - クライアントに送信される Set-Cookie ヘッダに Max-Age 属性を含むようになりました
PHP 5.2 - httponly ぱためーたが追加されました

その他の例

クッキーの有効期限:

<?php
$value = "Hello world!";

// cookie will expire when the browser close
setcookie("myCookie", $value);

// cookie will expire in 1 hour
setcookie("myCookie", $value, time() + 3600);

// cookie will expire in 1 hour, and will only be available
// within the php directory + all sub-directories of php
setcookie("myCookie", $value, time() + 3600, "/php/");
?>
<html>
<body>

...some code...

</body>
</html>
例の実行 »

クッキーを変更するには、setcookie()関数を使用してクッキーを(再)設定します:

<?php
$cookie_name = "user";
$cookie_value = "Alex Porter";
setcookie($cookie_name, $cookie_value, time() + (86400 * 30), "/");
?>
<html>
<body>

<?php
if(!isset($_COOKIE[$cookie_name])) {
    echo "Cookie named '" . $cookie_name . "' is not set!";
} else {
    echo "Cookie '" . $cookie_name . "' is set!<br>";
    echo "Value is: " . $_COOKIE[$cookie_name];
}
?>

</body>
</html>
例の実行 »

クッキーを削除するには、過去の有効期限で setcookie() 関数を使用します:

<?php
// set the expiration date to one hour ago
setcookie("user", "", time() - 3600);
?>
<html>
<body>

<?php
echo "Cookie 'user' is deleted.";
?>

</body>
</html>
例の実行 »

クッキーが有効かどうかを確認する小さなスクリプトを作成します。 まず、setcookie()関数でテストクッキーを作成し、次に$_COOKIE配列変数の数をカウントします:

<?php
setcookie("test_cookie", "test", time() + 3600, '/');
?>
<html>
<body>

<?php
if(count($_COOKIE) > 0) {
    echo "Cookies are enabled.";
} else {
    echo "Cookies are disabled.";
}
?>

</body>
</html>
例の実行 »

❮ PHP HTTP リファレンス