説明
パラメータ
- $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年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を(2013年11月6日 更新)
WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。