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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。