説明
パラメータ
パラメータはありません。返り値
現在のユーザ情報としてWP_Userのオブジェクト(グローバル変数$current_user)を返す。ユーザ情報のプロパティは次の通り。| プロパティ名 | データ型 | 意味 |
|---|---|---|
| data | Object | 基本データ |
| ID | int | ユーザID |
| caps | Array | 所有するロールの連想配列(キー名がロール名)。管理者の場合はキー名'administrator'の値が1を含む。 |
| cap_key | string | ロールのキー名 |
| roles | Array | 所有するロールの配列(値がロール名)。管理者の場合は'administrator'を含む。 |
| allcaps | Array | 所有する権限の連想配列(キー名が権限名) |
| filter | string | フィルター |
なお、以下のプロパティについては、少なくとも3.3では無くなっている。
| プロパティ名 | データ型 | 意味 |
|---|---|---|
| id | int | ユーザID |
| first_name | string | 名前 |
| last_name | string | 名字 |
| user_login | string | ログイン名 |
| user_pass | string | 暗号化されたパスワード |
| user_nicename | string | ナイスネーム |
| user_email | string | メールアドレス |
| user_url | string | ウェブサイト |
| user_registered | string | 登録日時(書式はyyyy-mm-dd hh:mm:ss) |
| user_activation_key | string | アクティベーションキー |
| user_status | int | ステータス |
| display_name | string | ブログ上の表示名 |
| spam | int | スパム |
| deleted | int | 削除状態 |
| nickname | string | ニックネーム |
| description | string | プロフィール情報 |
| rich_editing | bool | ビジュアルリッチエディターの状況 |
| comment_shortcuts | bool | キーボードショートカットの状況 |
| admin_color | string | 管理画面の配色 |
| use_ssl | int | SSL使用 |
| aim | string | AIM |
| yim | string | Yahoo IM |
| jabber | string | Jabber / Google Talk |
| wp_capabilities | Array | 所有するロールの連想配列 |
| wp_user_level | int | ユーザレベル |
| wp_dashboard_quick_press_last_post_id | int | クイック編集用の投稿ID |
| wp_usersettings | string | ユーザ設定内容 |
| wp_usersettingstime | int | ユーザ設定更新時間(秒数) |
| source_domain | string | ドメイン名 |
| primary_blog | int | ブログID |
| closedpostboxes_post | Array | クローズされている編集パーツの配列 |
| metaboxhidden_post | Array | 非表示の編集パーツの配列 |
| metaboxorder_post | Array | 編集パーツの並び順(キー名は'side'、'normal'、'advanced') |
| screen_layout_post | int | スクリーンレイアウト(列の数) |
| managenavmenuscolumnshidden | Array | 非表示のナビゲーションメニュー項目 |
| metaboxhidden_navmenus | Array | 非表示のナビゲーションメニュー編集パーツ |
| user_level | int | ユーザレベル |
| user_firstname | string | 名前 |
| user_lastname | string | 名字 |
| user_description | string | プロフィール情報 |
注意
この関数の内部では、 get_currentuserinfo関数を呼び出し、バージョン4.5.0以降はプライベート関数_wp_get_current_userを呼び出し、グローバル変数$current_userを更新する。
プライベート関数_wp_get_current_userでは、グローバル変数$current_userが未設定の場合、'determine_current_user'フィルターを呼び出し、認証クッキーを検証して認証されたユーザーをグローバル変数$current_userに適用する。
本関数は'init'アクション直前に実行される$wpのinitメソッド内で呼び出されており、通常では遅くともこの時点で認証されたユーザーが確定している。
使用例
- 現在のユーザ情報を取得する。<?php $userinfo = wp_get_current_user( ); >
フィルター
実行するフィルターはありません。アクション
実行するアクションはありません。ソースファイル
/wp-includes/pluggable.php最終更新 : 2024年02月21日 11:36
関連
お勧め
ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)
投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)
PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。
段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)
ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。
ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)
ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。