get_the_post_thumbnail

(2.9.0以降)
get_the_post_thumbnail - アイキャッチ画像のHTMLテキストを出力する

説明

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' ) ); ?>

フィルター

wp_get_attachment_image関数でアイキャッチ画像のHTMLテキストを取得する前に、パラメータで受け取った$sizeのフィルター処理を行う。
$size = apply_filters( 'post_thumbnail_size', $size );
結果を返す直前に実行される。$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

関連

お勧めコンテンツ

index.htmlでアーカイブページを表示させる(2011年10月14日 登録)

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた(こんなことを考えてるのは自分だけだろうか!?)。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 登録)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。

プラグインで注意が必要な関数(2013年11月27日 登録)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

Emojin:プラグイン作ってみました(2014年8月23日 登録)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Slightly troublesome permalink:プラグイン作ってみました(2012年2月9日 登録)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

最終更新日時 : 2014-09-12 19:36