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



お勧め

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

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

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