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年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。