get_post_thumbnail_id

説明

int | false get_post_thumbnail_id( [ int $post_id = null ] )
投稿情報にアイキャッチ画像(サムネイル)として設定されているアタッチメント情報のIDを取得する。

パラメータ

  • $post_id
    投稿情報IDを指定(省略時はnull)。

返り値

アイキャッチ画像として設定されているアタッチメント情報のIDを返す。アイキャッチ画像が設定されていない場合は''を返す。

[5.5.0]アイキャッチ画像が設定されていない場合は''ではなくfalseを返すように変更された。


注意

パラメータ$post_idを省略した場合はnullが適用され、現在の投稿情報のアイキャッチ画像のIDを取得する。

なお、以下に示す add_theme_support関数にてテーマがアイキャッチ画像をサポートしていないと本関数を含めアイキャッチ画像関連関数は未定義となるので、注意が必要である。

add_theme_support( 'post-thumbnails' );

使用例

  • アイキャッチ画像(サムネイル)のIDを取得する。
    <?php $thumbnail_id = get_post_thumbnail_id( ); ?>

フィルター

[5.9.0]アイキャッチ画像のIDを返す前に'post_thumbnail_id'フィルターを呼び出す。パラメータ$thumbnail_idにはアイキャッチ画像のIDが、$postには対象の投稿オブジェクトが格納されている。
return (int) apply_filters( 'post_thumbnail_id', $thumbnail_id, $post );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post-thumbnail-template.php

最終更新 : 2023年06月02日 16:59



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。