wp_set_auth_cookie

（2.5以降）
wp_set_auth_cookie - ログインIDをクッキーに保存する

説明

void wp_set_auth_cookie( int $user_id [ , bool $remember = false [ , mixed $secure = '' [ , string $token = '' ] ] ] )
ログインIDをクッキーに保存する。

パラメータ

  • $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 );
[3.1.0]セキュア判定（いくつかのsetcookie関数の第6パラメータ）を確定するため、'secure_auth_cookie'フィルターを呼び出す。 
$secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );
[3.1.0]ログイン済情報のセキュア判定（いくつかのsetcookie関数の第6パラメータ）を確定するため、'secure_logged_in_cookie'フィルターを呼び出す。 
$secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', false, $user_id, $secure );
[4.7.4]クッキーを送信する前に'send_auth_cookies'フィルターを呼び出す。 
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 );
[2.6.0]クッキーを保存する前に'set_logged_in_cookie'アクションを実行する。 
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

関連

参考

Code Reference: wp_set_auth_cookie

お勧め

5.3の新機能：クエリーログに任意の項目を追加できる新フィルター（2019年10月23日 更新）

「5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる（2018年5月27日 更新）

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数（2013年11月27日 更新）

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる（2019年12月11日 更新）

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。