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



お勧め

ログアウト後はいつもサイトトップ(2018年5月27日 更新)

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

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。

oEmbed対応サイトを整理した(2017年11月18日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

Login rebuilder:プラグイン作ってみました(2019年9月7日 更新)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。