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

最終更新 : 2022年02月01日 12:50



お勧め

フィードにサムネイル画像を追加する(2022年11月1日 更新)

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

index.htmlでアーカイブページを表示させる(2011年10月14日 更新)

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた(こんなことを考えてるのは自分だけだろうか!?)。