wp_get_attachment_image

(2.5.0以降)
wp_get_attachment_image - アタッチメント情報のHTMLテキストを取得する

説明

string wp_get_attachment_image( int $attachment_id [ , mixed $size = 'thumbnail' [ , bool $icon = false [ , mixed attr = '' ] ] ] )
アタッチメント情報のHTMLテキストを取得する。

パラメータ

  • $attachment_id
    アタッチメント情報のIDを指定。
  • $size
    サイズを文字列('thumbnail'、'post-thumbnail'、'small'、'medium'、'large'など)または配列(幅と高さのピクセル値)で指定(省略時は'thumbnail')。
  • $icon
    アイコン画像を使用する場合はtrue、使用しない場合はfalseを指定(省略時はfalse)。
  • $attr
    添付画像の属性を文字列または連想配列で指定(省略時は'')。

返り値

アタッチメント情報が存在する場合は、そのHTMLテキストを返す。アタッチメント情報が設定されていない場合は''を返す。

注意

パラメータ$iconでtrueを指定した場合、アタッチメント情報のタイプに応じたアイコン画像(/wp-includes/images/crystal/*.png)が適用される。

使用例

  • IDが25のアタッチメント情報のHTMLテキストを取得する。
    <?php $html = wp_get_attachment_image( 25 ); ?>
  • IDが25のアタッチメント情報のHTMLテキストを幅120ピクセルと高さ80ピクセルを指定して取得する。
    <?php $html = wp_get_attachment_image( 25, array( 120, 80 ) ); ?>
  • IDが25のアタッチメント情報のHTMLテキストをclass属性を追加して取得する。
    <?php $html = wp_get_attachment_image( 25, 'post-thumbnail', false, array( 'class'=>'alignleft' ) ); ?>

フィルター

パラメータ$attrを適用する前にwp_get_attachment_image_attributesフィルターが実行される。$attrにはデフォルトの属性値が加わった連想配列が、$attachmentには添付画像の投稿情報が格納さてる。
$attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/media.php

関連

お勧めコンテンツ

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

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

canvasタグを投稿したい(2013年12月27日 登録)

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。

get_postsとquery_postsを使い分け(2011年1月21日 登録)

get_postsquery_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

タイトルが一致する投稿を検索する(2014年2月20日 登録)

WordPressが提供する投稿ページの文字列検索機能の実現には、query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

ログインページを変える(2012年11月18日 登録)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

最終更新日時 : 2016-05-22 15:08