jQuery Cookie プラグイン

jQuery は jquery.cookie.js プラグインを使って Cookie を操作できます。

公式サイト:http://plugins.jquery.com/cookie/

Github アドレス:https://github.com/carhartl/jquery-cookie

jquery.cookie.js を使用する前に、jQuery を読み込む必要があります:

<script src="/path/to/jquery.min.js"></script> <script src="/path/to/jquery.cookie.js"></script>

サードパーティのリソースライブラリを使用して、これら 2 つのファイルを読み込むことができます:

<script src="https://cdn.staticfile.org/jquery/3.4.0/jquery.min.js"></script> <script src="https://cdn.staticfile.org/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>

使用方法

Cookie を作成:

$.cookie('name', 'value');

有効期限を指定しない場合、ブラウザを閉じると期限切れになります。

Cookie を作成し、7 日後に期限切れになるように設定:

$.cookie('name', 'value', { expires: 7 });

Cookie を作成し、Cookie の有効パスをサイトのルートディレクトリに設定:

$.cookie('name', 'value', { expires: 7, path: '/' });

注:デフォルトでは、Cookie を設定したウェブページだけがその Cookie を読み取ることができます。あるページが別のページで設定された Cookie を読み取らせたい場合は、Cookie のパスを設定する必要があります。Cookie のパスは、Cookie を読み取ることができる最上位ディレクトリを設定するために使用されます。このパスをサイトのルートディレクトリに設定すると、すべてのウェブページが相互に Cookie を読み取れるようになります(通常は衝突を防ぐためにこのように設定しないでください)。

Cookie を読み取り:

$.cookie('name'); // => "value"
$.cookie('nothing'); // => undefined

すべての Cookie 情報を読み取り:

$.cookie(); // => { "name": "value" }

Cookie を削除:

//Cookie の削除が成功すると true を返し、それ以外の場合は false を返します $.removeCookie('name'); // => true $.removeCookie('nothing'); // => false //書き込み時に path を使用した場合、読み取り時にも同じ属性 (path, domain) を使用する必要があります $.cookie('name', 'value', { path: '/' }); //以下のコードは【削除失敗】です $.removeCookie('name'); // => false //以下のコードは【削除成功】です $.removeCookie('name', { path: '/' }); // => true

注意:Cookie を削除するときは、Cookie の設定に使用したものと完全に同じパス、ドメイン、およびセキュリティオプションを渡す必要があります。

例

$(document).ready(function(){ $.cookie('name', 'サンプル'); //Cookie を作成 name = $.cookie('name'); //Cookie を読み取り $("#test").text(name); $.cookie('name2', 'サンプル2', { expires: 7, path: '/' }); name2 = $.cookie('name2'); $("#test2").text(name2); });

試してみる »

実行後、ブラウザで Cookie 情報を確認できます。下図のようになります:


パラメータの説明

raw

デフォルト値: false。

デフォルトでは、Cookie の読み書き時に自動的にエンコードとデコードが行われます(encodeURIComponent でエンコード、decodeURIComponent でデコード)。この機能を無効にするには、raw:true を設定します:

$.cookie.raw = true;

json

Cookie のデータを JSON で保存・読み取りするように設定します。この場合、JSON.stringify と JSON.parse を使用する必要はありません。

$.cookie.json = true;

expires

expires: 365

Cookie の有効時間を定義します。値は数値(Cookie 作成時から日数で計算)または Date オブジェクトを指定できます。省略した場合、作成される Cookie はセッション Cookie となり、ユーザーがブラウザを終了すると削除されます。

path

path: '/'

デフォルトでは、Cookie を設定したウェブページだけがその Cookie を読み取ることができます。

Cookie の有効パスを定義します。デフォルトでは、このパラメータの値は Cookie を作成したウェブページのパスです(標準ブラウザの動作)。

サイト全体でこの Cookie にアクセスしたい場合は、有効パスを次のように設定する必要があります: path: '/'。有効パスを定義した Cookie を削除したい場合は、関数を呼び出すときにこのパスを含める必要があります:

$.cookie('the_cookie', null,{ path: '/' });

domain

domain: 'example.com'

デフォルト値: Cookie を作成したウェブページが所有するドメイン。

secure

secure: true

デフォルト値: false。true の場合、Cookie の送信には安全なプロトコル(HTTPS)を使用する必要があります。

その他の拡張