jQuery Cookieは、クッキーを、取得、作成、削除できる軽量なjQueryプラグイン。
導入
jQuery Cookie | jQuery Plugin Registryのページより、「Download now」をクリックし「jquery.cookie.js」などをダウンロード。
読み込み
<script src="jquery.cookie.js"></script>
jQueryのプラグインなので、「jquery.js」の読み込みも忘れずに。
実装例(サンプル)
回目の訪問。
実装例(サンプル)の動作について
このページに訪れるたびに、訪問回数をカウントアップしていく。
実装例(サンプル)のソースコードなど詳細については、jQuery Cookie を使い訪問回数をカウントのページへ。
構文
取得
jQuery.cookie( cookieName );
引数
- cookieName
取得したいクッキーの名前を指定。
戻り値
クッキーの値。
引数「cookieName」に指定したクッキーが存在しなかった場合、「undefined」を返す。
作成
jQuery.cookie( cookieName, value, options );
引数
- cookieName
設定したいクッキーの名前を指定。
- value
値を指定。
- options
オプション。省略可能。
{ expires: 1, path: '/' }
のように、オブジェクトリテラルで指定する。- expires
クッキーの有効日数を指定。
このオプションの設定を省略した場合、セッションクッキーになる。
- path
クッキーが有効であるパスを指定。
初期設定値は、クッキーを生成したページのパス。
- domain
クッキーが有効であるドメインを指定。
初期設定値は、クッキーを生成したページのドメイン。
- secure
「true」を指定すると、クッキーの送信には、安全なプロトコル(https)が必要になる。
初期設定値は「false」。
削除
jQuery.removeCookie( cookieName, options );
引数
- cookieName
削除したいクッキーの名前を指定。
- options
クッキーを作成時と同じオプション設定にする必要がある。
初期設定値のオプションでクッキーを作成したのであれば、特に必要ない。