wp_generate_auth_cookie

（2.5.0以降）
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

関連

参考

Code Reference: wp_generate_auth_cookie

お勧め

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

Gutenberg、初見です（2018年8月6日 更新）

先週末、WordPress 4.9.8がリリースされ、事前に告知されてたように「Gutenberg」がお披露目になった。投稿編集ページがガラリと変わり、影響範囲はそれなりに大きいと思われる。まずはこの週末に感じたことを整理してみた。

初期状態で「抜粋」ウィジェットを表示する（2014年1月7日 更新）

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

使っていないか確認しないとね！（フィルター編）（2019年4月24日 更新）

先週末にWordPress 5.2 Beta3（以降5.2Beta3）が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。