wp_get_attachment_image_src

説明

mixed wp_get_attachment_image_src( int $attachment_id [ , mixed $size = 'thumbnail' [ , bool $icon = false ] ] )
添付ファイルの表示用データを取得する。

パラメータ

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

返り値

添付ファイルの表示用データを配列で返す。配列は、イメージファイルのURL、幅、高さの順に格納されている。表示用データを取得できなかった場合はfalseを返す。

注意

添付ファイルが画像ファイルの場合とそれ以外のデータファイルの場合では振る舞いが異なる。画像ファイルの場合は、アップロード時に指定した表示用イメージの情報を取得でき、4番目の要素には縮小イメージ(true)か元イメージ(false)かを示す。画像ファイル以外の場合は、/wp-includes/images/crystalにあるアイコン(アーカイブ、音楽、動画、文書、テキストなど)の情報を取得できる。

使用例

  • 画像ファイルの添付ファイルIDが100の表示用データを取得する。
    <?php $data = wp_get_attachment_image_src( 100 ); ?>
  • 画像ファイル以外の添付ファイルIDが200の表示用アイコンのデータを取得する。
    <?php $data = wp_get_attachment_image_src( 100, 'none', true ); ?>

フィルター

[2.5.0]パラメータ$attachment_idでイメージ情報が取得できず$iconがtrueの場合にicon_dirフィルターを呼び出す。パラメータ$icon_dirは'/wp-includes/images/media'ディレクトリのフルパス名が格納されている。
$icon_dir = apply_filters( 'icon_dir', $icon_dir );
[4.3.0]取得したイメージ情報を返す直前にwp_get_attachment_image_srcフィルターをを呼び出す。パラメータ$imageはイメージ情報が、その他のパラメータには本関数が受け取った内容が格納される。
return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );

アクション

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

ソースファイル

/wp-includes/media.php

最終更新 : 2015年12月23日 09:02



お勧め

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

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

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。