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

お勧め

初期状態で「抜粋」ウィジェットを表示する（2014年1月7日 更新）

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

query_posts（WP_Queryクラス）で投稿タグを絞り込む（2011年9月14日 更新）

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

カスタムフィールド関連関数のおさらい（2012年6月22日 更新）

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

Align widgets horizontally：プラグイン作ってみました（2024年5月6日 更新）

ほぼ毎日何度も見ているダッシュボードページ。自分好みに各ウィジェットの場所を配置しているものの、何かすっきりしない。そこでふと思ったのが、ウィジェットを横並びにできれば隣り合うウィジェットの並びがガタガタしなくなるのでは！？

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

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