wp_generate_auth_cookie

説明

string wp_generate_auth_cookie( int $user_id, int $expiration [ , string $scheme = 'auth' [ , string $token = '' ] ] )
認証クッキーの内容を生成する。

パラメータ

  • $user_id
    ユーザーIDを指定。
  • $expiration
    クッキーの有効期限(秒)を指定。
  • $scheme
    認証クッキーのスキームとして'auth'、'secure_auth'、'logged_in'を指定(省略時は'auth')。
  • $token
    [4.0.0]認証クッキーのセッショントークンを指定(省略時は'')。

返り値

認証クッキーの内容を返す。パラメータ$user_idのユーザーが存在しなかった場合は''を返す。


注意

本関数は wp_set_auth_cookie関数から呼び出され、認証時クッキーの内容を生成する。

[4.0.0]パラメータ$tokenが追加され、ハッシュ値のメッセージの一部や認証クッキーの内容に使用される。


使用例

  • 有効期限が1日後の認証クッキーの内容を生成する
    $cookie = wp_generate_auth_cookie( $user->ID, time() + DAY_IN_SECONDS, 'logged_in' );

フィルター

[2.5.0]認証クッキーの内容を返す前に'auth_cookie'フィルターを呼び出す。パラメータ$cookieには認証クッキーの内容が、$user_id$expiration$schemeには本関数が受け取った内容が格納されている。[4.0.0]$tokenには受け取った内容または認証クッキーのセッショントークンが格納されている。
return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme, $token );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2024年02月20日 10:59



お勧め

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

PHPとMySQLのバージョンを確認(2013年9月11日 更新)

先日、WordPressで構築されたサイトについて最新版へのバージョンアップを依頼される。使用されていたWordPressはバージョン2.xということで、最新版へバージョンアップできるのか、PHPとMySQLのバージョンを確認することになった。

ACF(Advanced Custom Fields)向けにデータをインポートした時のメモ(2023年7月11日 更新)

ACFを採用するサイトにデータをインポートする際、ほとんどのことはwww.advancedcustomfields.comに記載されていたのだが、いくつかわからないことがあった。ここでは、その時に調べたことをメモしておく。

不要なプラグインを読み込まない(2023年6月2日 更新)

稼働中のサーバーにてバックグラウンドで何か処理しようとコマンドラインのプログラムを作る際、効率化や誤動作のリスクを考えると不要なプラグインはロードしないようにしたい。そんなわけで設定内容(データベース)は変更せず、特定のプラグインをロードしないようにできないか考えてみた。

Align widgets horizontally:プラグイン作ってみました(2024年2月28日 更新)

ほぼ毎日何度も見ているダッシュボードページ。自分好みに各ウィジェットの場所を配置しているものの、何かすっきりしない。そこでふと思ったのが、ウィジェットを横並びにできれば隣り合うウィジェットの並びがガタガタしなくなるのでは!?