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]セッションのトークンを指定(省略時は'')。

返り値

返り値はありません。

注意

本関数は定数SECURE_AUTH_COOKIEまたはAUTH_COOKIEの認証クッキーと、LOGGED_IN_COOKIEのログインクッキーを設定する。

パラメータ$rememberはログインフォームの「Remember Me(ログイン状態を保存する)」の状態を表し、trueの場合は認証クッキーの有効期間が14日間、期限切れがその日時に有効期間と12時間を加えた秒数となる。$rememberがfalseの場合は有効期限が2日間、期限切れが0(ブラウザが閉じるとクッキーが削除される)となる。

[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'フィルターを呼び出す。 [6.2.0]パラメータ$expire$expiration$user_id$scheme$tokenが追加された。
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 );
[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

最終更新 : 2024年02月22日 12:59



お勧め

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

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

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。