説明
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
関連
お勧め
任意の名前でエラーログファイルを指定する(2019年2月15日 更新)
来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。
Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)
カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。テキストエディタの文字を変更する(2018年5月27日 更新)
テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。