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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。