説明
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
関連
お勧め
Contact Form 7に確認フェーズを（2012年12月16日 更新）
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。投稿一覧に独自リンクを追加する（2013年10月16日 更新）
管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。HTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。投稿日の検索が自由自在に（2015年3月7日 更新）
WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス（もちろん query_posts関数でも）で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。
プラグインのヘッダー情報を国際化対応しよう（2018年5月27日 更新）
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。