get_the_post_thumbnail：WordPress私的マニュアル

get_the_post_thumbnail

(2.9.0以降)
get_the_post_thumbnail - アイキャッチ画像のHTMLテキストを出力する

説明

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テキストを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' ) ); ?>

フィルター

wp_get_attachment_image関数でアイキャッチ画像のHTMLテキストを取得する前に、パラメータで受け取った$sizeのフィルター処理を行う。

$size = apply_filters( 'post_thumbnail_size', $size );

結果を返す直前に実行される。$htmlにはアイキャッチ画像のHTMLテキストが格納されており、このフィルターで任意の処理を行うことができる。

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