説明
パラメータ
- $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 ) ) {
アクション
[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最終更新 : 2019年06月10日 12:50
関連
お勧め
ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)
管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。
headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)
標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。<meta name="generator" content="WordPress 3.0.5" />
Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。
5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。