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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。