説明
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
関連
お勧め
自動生成される抜粋からテーブルブロックの内容を除外する（2022年4月6日 更新）
標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。
Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。ダッシュボードのフィードボックスをカスタマイズ（2011年7月8日 更新）
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する（管理者権限）。投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）
WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。
さくらのVPSでKUSANAGI#2（2018年5月27日 更新）
今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。