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



お勧め

初期状態で「抜粋」ウィジェットを表示する(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)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。