説明
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
関連
お勧め
任意の名前でエラーログファイルを指定する（2019年2月15日 更新）
来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。
Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）
カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。テキストエディタの文字を変更する（2018年5月27日 更新）
テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。