get_the_post_thumbnail

説明

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 );
[2.9.0]結果を返す直前に'post_thumbnail_html'フィルターが呼び出される。パラメータ$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

最終更新 : 2018年05月27日 10:50



お勧め

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。