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

最終更新 : 2017年12月11日 09:48



お勧め

ログアウト後はいつもサイトトップ(2015年5月7日 更新)

ログアウト後に表示(リダイレクト)されるページは、標準ではログインページ(wp-login.php)である。4.2.0ではログアウト処理後のページリダイレクト前に呼び出されるフィルターが追加された。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない(2015年3月21日 更新)

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

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

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

xmlrpc.phpへのアクセスについてちょっと考えた(2015年7月11日 更新)

少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。