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



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。