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



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

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

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

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。