概要
get_current_user_id関数は、現在のログイン済みユーザーのIDを取得するためのWordPressの関数です。この関数は、ユーザーの認証や権限の確認を行う際によく使われます。以下は、一般的な利用シーンの例です。
- ユーザーのプロフィール情報を表示する。
- カスタムコンテンツの公開・非公開を制御する。
- ユーザーのアクティビティログを記録する。
- ユーザーへの通知機能を実装する。
- 特定のユーザーにのみ表示されるコンテンツを作成する。
- フォームデータを特定のユーザーにマッピングする。
- ログイン状態に応じたメニュー項目を表示する。
- カスタムダッシュボードウィジェットを作成する。
構文
int get_current_user_id();
パラメータ
この関数にはパラメータはありません。
戻り値
現在のログイン済みユーザーのIDを整数値で返します。ログインしていない場合は、0を返します。
関連する関数
使用可能なバージョン
この関数はWordPress 2.0.0以降で使用可能です。
コアファイルのパス
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 |
特定のワードプレスバージョンで非推奨又は削除された場合は、情報はありません。
サンプルコード
サンプル1: 現在のユーザーIDを取得し表示する
$current_user_id = get_current_user_id();
echo 'Your User ID is: ' . $current_user_id;
このサンプルでは、現在のユーザーIDを取得し、そのIDを表示します。
サンプル2: ユーザーがログインしているか確認する
if (get_current_user_id() !== 0) {
echo 'User is logged in.';
} else {
echo 'User is not logged in.';
}
このサンプルでは、ユーザーがログインしているかどうかを確認し、メッセージを出力します。
サンプル3: ユーザーの役割をチェックする
if (user_can(get_current_user_id(), 'administrator')) {
echo 'You are an administrator.';
}
このサンプルでは、現在のユーザーが管理者権限を持っているかチェックし、メッセージを出力します。
サンプル4: 現在のユーザーに投稿を表示する
$current_user_id = get_current_user_id();
$args = array('author' => $current_user_id);
$posts = get_posts($args);
foreach ($posts as $post) {
echo '<h2>' . $post->post_title . '</h2>';
}
このサンプルでは、現在のユーザーが書いた投稿のタイトルを表示します。
サンプル5: カスタムユーザーメニューを表示する
if (get_current_user_id()) {
echo '<a href="/profile">My Profile</a>';
echo '<a href="/logout">Logout</a>';
}
このサンプルでは、ユーザーがログインしている場合に、プロフィールとログアウトのリンクを表示します。