wp_get_attachment_image

説明

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

最終更新 : 2018年05月27日 10:50



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。