概要
get_queried_object_id関数は、ページリクエストにマッチした情報のIDを取得するために使用されます。この関数は、主に次のようなシナリオでよく使われます。
- 投稿の詳細を表示する際に、現在の投稿のIDを取得する。
- 特定のカスタム投稿タイプに関連するデータを取得するとき。
- カテゴリーやタグのページで、それに関連するIDを取得する。
- ユーザーのプロフィールページで、そのユーザーIDを取得する。
- ページテンプレートの条件分岐で現在のオブジェクトのIDチェックを行う時。
- フロントエンドの表示内容をカスタマイズする際にオブジェクトIDを利用する。
- REST APIエンドポイントで特定のオブジェクトを取得する時。
- ループ外でのデータ取得や表示に役立てる。
構文
get_queried_object_id();
パラメータ
この関数は引数を取りません。
戻り値
- 現在のクエリで取得されたオブジェクトのID（整数）を返します。対象のオブジェクトが存在しない場合、0を返します。
関連する関数
使用可能なバージョン
この関数はWordPress 3.1.0以降から使用可能です。
コアファイルのパス
get_queried_object_id関数は、wp-includes/query.phpに含まれています。
サンプルコード
サンプル1: 投稿IDの取得
$post_id = get_queried_object_id();
echo '現在の投稿のID: ' . $post_id;
このサンプルでは、現在表示されている投稿のIDを取得し、そのIDを表示します。
サンプル2: カスタム投稿タイプのページでの使用
if (is_singular('custom_post_type')) {
$object_id = get_queried_object_id();
// 取得したIDを使ってカスタムデータを取得
}
このコードは、カスタム投稿タイプのページで現在のオブジェクトのIDをチェックし、必要な処理を行います。
サンプル3: タグページでのID取得
if (is_tag()) {
$tag_id = get_queried_object_id();
echo '現在のタグのID: ' . $tag_id;
}
このサンプルでは、現在表示されているタグのページからIDを取得し、そのIDを表示します。
サンプル4: ユーザープロフィールのID獲得
if (is_author()) {
$user_id = get_queried_object_id();
echo '現在のユーザーのID: ' . $user_id;
}
このコードは、ユーザープロフィールページでそのユーザーのIDを取得し表示します。
サンプル5: 条件分岐ループ外でのID利用
$queried_id = get_queried_object_id();
if ($queried_id) {
// 取得したIDを利用した処理
}
このサンプルでは、取得したIDがあれば、そのIDに基づいた処理を行います。
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| 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 | 〇 |
非推奨又は削除情報
get_queried_object_id関数は、特定のバージョンで非推奨または削除された情報は現在ありません。