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



お勧め

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クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。