wp_parse_auth_cookie

（2.7.0以降）
wp_parse_auth_cookie - 認証クッキーを解析して要素を取得する

説明

string[] | false wp_parse_auth_cookie( [ string $cookie = '' [ , string $scheme = '' ] ] )
認証クッキーを解析して要素を取得する。

パラメータ

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

返り値

認証クッキーが解析できた場合はその要素を連想配列で返す。認証クッキーがないか不適切な内容の場合はfalseを返す。

[4.0.0]キーtokenが追加された。

キー内容
usernameユーザー名
expiration有効期限（秒）
tokenセッショントークン
hmacハッシュ値
scheme認証クッキーのスキーム

注意

認証クッキー名は定数AUTH_COOKIE、SECURE_AUTH_COOKIE、LOGGED_IN_COOKIEとなる。

パラメータ$cookieの内容が空の場合、パラメータ$schemeに応じた認証クッキーが解析される。$schemeが空の場合は is_ssl関数の結果に応じてAUTH_COOKIEとSECURE_AUTH_COOKIEのどちらかが対象となる。

使用例

  • 認証クッキーを解析して要素を取得する
    $cookie_elements = wp_parse_auth_cookie( $_COOKIE[ LOGGED_IN_COOKIE ] );
  • 認証クッキーを解析して要素を取得する
    $cookie_elements = wp_parse_auth_cookie( '', 'logged_in' );

フィルター

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

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2024年02月22日 12:59

関連

参考

Code Reference: wp_parse_auth_cookie

お勧め

個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

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

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

サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。