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

お勧め

Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

古めのリビジョンを削除した時のメモ（2022年5月16日 更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

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

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

「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。