説明
string get_the_post_thumbnail( [ int $post_id = null [ , mixed $size = 'post-thumbnail' [ , mixed $attr = '' ] ] ] )
アイキャッチ画像（サムネイル）のHTMLテキストを取得する。
パラメータ
- $post_id投稿情報IDを指定（省略時はnull）。
- $sizeサイズを文字列または配列で指定（省略時は'post-thumbnail'）。
- $attrアイキャッチ画像取得時の属性を文字列または連想配列で指定（省略時は''）。
返り値
アイキャッチ画像を表示するimgタグのHTMLテキストを返す。注意
パラメータ$post_idを省略した場合はnullが適用され、現在の投稿情報を対象としてアイキャッチ画像を調べ、HTMLテキストを生成する。なお、以下に示す add_theme_support関数にてテーマがアイキャッチ画像をサポートしていないと本関数を含めアイキャッチ画像関連関数は未定義となるので、注意が必要である。
add_theme_support( 'post-thumbnails' );
使用例
- アイキャッチ画像（サムネイル）のHTMLテキストを取得する。<?php $thumbnail = get_the_post_thumbnail( ); ?>
- $post_idで指定した投稿記事に添付されているアイキャッチ画像（サムネイル）のHTMLテキストをサイズを指定して取得する。<?php $thumbnail = get_the_post_thumbnail( $post_id, array( 250, 250 ) ); ?>
- $post_idで指定した投稿記事に添付されているアイキャッチ画像（サムネイル）のHTMLテキストをclass属性を文字列で指定して取得する。<?php $thumbnail = get_the_post_thumbnail( $post_id, 'post-thumbnail', 'class=photo_frame' ); ?>
- $post_idで指定した投稿記事に添付されているアイキャッチ画像（サムネイル）のHTMLテキストをclass属性を連想配列で指定して取得する。<?php $thumbnail = get_the_post_thumbnail( $post_id, 'post-thumbnail', array( 'class'=>'photo_frame' ) ); ?>
フィルター
[2.9.0]サムネールを準備する前に'post_thumbnail_size'フィルターを呼び出す。パラメータ$sizeには本関数が受け取った内容が格納されている。[4.9.0]パラメータ$post_idが追加され、投稿IDが格納されている。$size = apply_filters( 'post_thumbnail_size', $size, $post_id );return apply_filters( 'post_thumbnail_html', $html, $post_id, $post_thumbnail_id, $size, $attr );アクション
wp_get_attachment_image関数にてアイキャッチ画像のHTMLを取得する前に実行される。
do_action( 'begin_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size );
wp_get_attachment_image関数にてアイキャッチ画像のHTMLを取得した後に実行される。
do_action( 'end_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size );
ソースファイル
/wp-includes/post-thumbnail-template.php最終更新 : 2022年01月31日 12:41
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。