概要
get_post_thumbnail_id 関数は、特定の投稿に関連付けられたアイキャッチ画像のIDを取得するために使用されます。この関数は、WordPressの投稿システムにおいて、アイキャッチ画像を操作する際に非常に便利です。主に以下のような機能を実装する際によく使われます。
- 投稿の詳細ページでアイキャッチ画像を表示する
- カスタムクエリの結果に基づいてアイキャッチ画像を取得する
- アイキャッチ画像をサムネイルとして使用したギャラリーを作成する
- アイキャッチを持つ投稿のフィルタリングを行う
- ベースとなるテーマ調整のためにアイキャッチをテーマ内で利用する
- 投稿の一覧表示にアイキャッチ画像を追加するカスタムショートコードを作成する
- アイキャッチ画像を動的に変更するカスタムプラグインの開発
- WP REST APIを介してアイキャッチ画像にアクセスする際のデータ取得
構文
get_post_thumbnail_id( int|WP_Post $post_id = null );
パラメータ
$post_id(optional): 投稿のIDまたはWP_Postオブジェクト。指定しない場合、現在の投稿が使用されます。
戻り値
- アイキャッチ画像のID（整数）。投稿にアイキャッチ画像が設定されていない場合は、0を返します。
関連する関数
使用可能なバージョン
- WordPress 2.9.0以降
コアファイルのパス
/wp-includes/post.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を取得する
$post_id = get_the_ID();
$thumbnail_id = get_post_thumbnail_id($post_id);
このコードは、現在の投稿のIDを利用して、アイキャッチ画像のIDを取得します。
サンプル 2: アイキャッチ画像を表示する
$thumbnail_id = get_post_thumbnail_id();
if ($thumbnail_id) {
echo wp_get_attachment_image($thumbnail_id, 'full');
}
このコードは、投稿のアイキャッチ画像IDを取得し、それを使って画像を表示します。
サンプル 3: アイキャッチ画像の有無を確認
if (has_post_thumbnail()) {
$thumbnail_id = get_post_thumbnail_id();
// 画像IDを使った処理
}
このコードは、投稿にアイキャッチ画像が設定されているかを確認し、設定されている場合はそのIDを取得します。
サンプル 4: 特定の投稿のアイキャッチ画像IDを取得
$thumbnail_id = get_post_thumbnail_id(42); // 42は投稿ID
このコードは、指定した投稿ID（ここでは42）のアイキャッチ画像のIDを取得します。
サンプル 5: アイキャッチ画像が設定されていない場合の処理
$thumbnail_id = get_post_thumbnail_id();
if ($thumbnail_id == 0) {
echo 'この投稿にはアイキャッチ画像が設定されていません。';
}
このコードは、アイキャッチ画像が設定されていない場合にメッセージを表示します。