概要
wp_parse_auth_cookie 関数は、WordPressにおける認証クッキーを解析して要素を取得するための関数です。この関数を使用することで、ユーザーの認証情報を取得し、しっかりとしたセキュリティを保ちながら、ユーザーのセッションを管理することが可能になります。一般的に以下のような機能を実装する際によく使われます。
- ユーザーのログイン状態を確認する
- ショッピングカートのセッション管理
- ユーザーアカウントのセキュリティを強化
- アクセス制限の適用
- 認証トークンの生成
- セッションのリフレッシュ
- ユーザー関連データの取得
- APIへの認証要求の処理
構文
wp_parse_auth_cookie( $cookie, $scheme );
パラメータ
$cookie(string): 認証クッキーの値。省略した場合は、デフォルトで$_COOKIE['wordpress_logged_in']が使用されます。$scheme(string): 認証スキーム。省略された場合は、デフォルトのスキームが使用されます。
戻り値
- (array|false): 認証クッキーが正常に解析された場合は、その情報を含む配列を返します。解析が失敗した場合は
falseを返します。
関連する関数
使用可能なバージョン
wp_parse_auth_cookie関数は、WordPress 2.5 以降で利用可能です。
コアファイルのパス
wp-includes/pluggable.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | 〇 |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
wp_parse_auth_cookie 関数は、現在のバージョンでは非推奨や削除はされていません。