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

最終更新 : 2022年01月31日 12:41



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

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

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