説明
パラメータ
- $user_idユーザIDを指定。
- $rememberブラウザが閉じた後もクッキーを保持する場合はtrue、保持しない場合はfalseを指定(省略時はfalse)。
- $secureセキュア時はtrueを指定(省略時は'')。
- $token[4.3.0]セッションのトークンを指定(省略時は'')。
返り値
返り値はありません。注意
パラメータ$rememberがtrueの場合、デフォルトのクッキーの有効期間は14日間となる。
[4.7.4]'send_auth_cookies'フィルターが追加され、クッキーの送信を制御できるようになった(falseを返すとクッキーは送信されない)。
[4.9.0]'set_auth_cookie'および'set_logged_in_cookie'アクションのパラメータに$tokenが追加された。
使用例
- ログインIDをクッキーに保存する。<?php wp_set_auth_cookie( $user_id ); ?>
- ブラウザが閉じた後もログインIDをクッキーに保存する。<?php wp_set_auth_cookie( $user_id, true ); ?>
フィルター
[2.8.0]始めに有効期間を'auth_cookie_expiration'フィルターを呼び出す。/* $rememberがtrueの場合 */
$expiration = $expire = time() + apply_filters( 'auth_cookie_expiration', 1209600, $user_id, $remember );
/* $rememberがfalseの場合 */
$expiration = time() + apply_filters( 'auth_cookie_expiration', 172800, $user_id, $remember );
$secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );
$secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', false, $user_id, $secure );
if ( ! apply_filters( 'send_auth_cookies', true, $expire, $expiration, $user_id, $scheme, $token ) ) {
アクション
[2.5.0]クッキーを保存する前に'set_auth_cookie'アクションを実行する。do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme, $token );
do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in', $token );
ソースファイル
/wp-includes/pluggable.php最終更新 : 2023年03月31日 10:28
関連
お勧め
投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)
サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。
連番のユーザーIDを回避できないか考えた(2019年6月4日 更新)
WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。
Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
4.2.3でちょっと変わったショートコード(2018年5月27日 更新)
4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。
「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)
投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。