PHP setrawcookie() 関数

❮ PHP HTTP リファレンス

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

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

<?php
echo "Cookie is set.";
?>

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

定義と用法

setrawcookie() 関数は、その他のHTTPヘッダーと共に送信される(URLエンコーディングしない)クッキーを定義します。

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

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

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

注: 送信時にクッキー値を自動的にURLエンコードし、受信時に自動的にデコードするには、代わりに the setcookie()関数を使用します。

構文

setrawcookie(name,value,expire,path,domain,secure);

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

技術内容
返り値: 成功した場合は TRUEを、失敗した場合は FALSEを返します
PHP バージョン: 5+

その他の例

"user" という名前のクッキーの値を取得します(グローバル変数$_COOKIEを使用)。また、isset()関数を使用して、クッキーが存在するかどうかも調べます:

<html>
<body>

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

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

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

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

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

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

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

<?php
$cookie_name = "user";
unset($_COOKIE[$cookie_name]);
// empty value and expiration one hour before
$res = setrawcookie($cookie_name, '', time() - 3600);
?>
<html>
<body>

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

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

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

<?php
setrawcookie("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 リファレンス