wp_validate_auth_cookie

（2.5.0以降）
wp_validate_auth_cookie - 認証クッキーを検証する

説明

int | false wp_validate_auth_cookie( [ string $cookie = '' [ , string $scheme = '' ] ] )
認証クッキーを検証する。

パラメータ

  • $cookie
    認証クッキーを指定（省略時は''）。
  • $scheme
    認証クッキーのスキームとして'auth'、'secure_auth'、'logged_in'を指定（省略時は''）。

返り値

認証クッキーが検証できた場合はユーザーIDを返す。認証クッキーがないか不適切な内容の場合はfalseを返す。

注意

wp_parse_auth_cookie関数を使って、認証クッキーの要素を取得し、各要素を検証する。

AJAX実行時かリクエストメソッドが'POST'の場合、有効期限は1時間延長される。

認証クッキーが有効期限切れの場合はグローバル変数$login_grace_periodに1を格納する。

使用例

  • 認証クッキーを検証する
    if ( wp_validate_auth_cookie() ) :

フィルター

直接実行するフィルターはありません。

アクション

[2.7.0]認証クッキーの要素を取得できなかった場合、falseを返す前に'auth_cookie_malformed'アクションを呼び出す。パラメータ$cookie、$schemeには本関数が受け取った内容が格納されている。 
do_action( 'auth_cookie_malformed', $cookie, $scheme );
[2.7.0]認証クッキーが有効期限切れの場合、falseを返す前に'auth_cookie_expired'アクションを呼び出す。パラメータ$cookie_elementsには認証クッキーを解析した要素の連想配列が格納されている。 
do_action( 'auth_cookie_expired', $cookie_elements );
[2.7.0]認証クッキーのユーザー名要素から該当するユーザーが見つからなかった場合、falseを返す前に'auth_cookie_bad_username'アクションを呼び出す。パラメータ$cookie_elementsには認証クッキーを解析した要素の連想配列が格納されている。 
do_action( 'auth_cookie_bad_username', $cookie_elements );
[2.7.0]認証クッキーのハッシュ値が不適切な場合、falseを返す前に'auth_cookie_bad_hash'アクションを呼び出す。パラメータ$cookie_elementsには認証クッキーを解析した要素の連想配列が格納されている。 
do_action( 'auth_cookie_bad_hash', $cookie_elements );
[4.0.0]認証クッキーのセッショントークンが不適切な場合、falseを返す前に'auth_cookie_bad_session_token'アクションを呼び出す。パラメータ$cookie_elementsには認証クッキーを解析した要素の連想配列が格納されている。 
do_action( 'auth_cookie_bad_session_token', $cookie_elements );
[2.7.0]認証クッキーを検証できた場合に'auth_cookie_valid'アクションを呼び出す。パラメータ$cookie_elementsには認証クッキーを解析した要素の連想配列が、$userにはユーザー情報（WP_Userオブジェクト）が格納されている。 
do_action( 'auth_cookie_valid', $cookie_elements, $user );

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2024年02月19日 16:59

関連

参考

Code Reference: wp_validate_auth_cookie

お勧め

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。

続テーマを変更せずにWebフォントを使ってみた（2022年2月8日 更新）

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

ブロックエディターで現在の「ロケール」を取得した時のメモ（2024年8月10日 更新）

ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール（言語）を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。

スマートフォン向けの振り分けを自前で行う（2012年1月23日 更新）

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。