wp_set_auth_cookie

説明

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



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。