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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。