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

関連

お勧めコンテンツ

CSSやJavaScriptファイルのバージョン番号を変える(2017年3月14日 登録)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

add_actionを使って管理ページで独自cssを使う(2011年2月25日 登録)

テーマやプラグインで専用の管理ページを作る場合、そのページ向けのcssやjavascriptが必要になることがある。どちらもページ内に直接記述できるが、特にcssは別ファイルに分けたいほうが便利だ。ここではその方法を紹介しよう。

使っていないか確認しないとね!(2011年6月8日 登録)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.7.0現在、廃止予定となっている関数をまとめて紹介する。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 登録)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

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

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

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