• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp get attachment image src

提供: WordPress Codex 日本語版
移動先: 案内検索

添付された画像ファイルの"url"、"width"、"height"属性を配列として返す関数です。
注: 画像ソースのみの場合は、一番最初のエレメントを使ってください。

使い方

<?php wp_get_attachment_image_src( $attachment_id, $size, $icon ); ?>


パラメータ

$attachment_id
整数) (必須) 所望する添付のID
初期値: なし
$size
文字列/配列) (オプション) 画像の大きさ。キーワードとなる文字列 (thumbnail, medium, large, full)または2つのアイテムを持つ配列が幅と高さをピクセルで、array(32,32)という形で表します。Version 2.5以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。
初期値: thumbnail
$icon
真偽値) (オプション) 添付を表すメディアアイコンを使用する。
初期値: false

戻り値

(配列) 
配列は以下を含みます:
  • [0] => url
  • [1] => width
  • [2] => height
  • [3] => 真偽値: リサイズされいている場合は true、元のサイズの場合は false
(true/false) 
画像でない場合は、 false を返します。


用例

デフォルトの使い方

<?php 
$attachment_id = 8; // 添付ID

$image_attributes = wp_get_attachment_image_src( $attachment_id ); // returns an array
if( $image_attributes ) {
?> 
<img src="<?php echo $image_attributes[0]; ?>" width="<?php echo $image_attributes[1]; ?>" height="<?php echo $image_attributes[2]; ?>">
<?php } ?>

アイコンディレクトリを変更する

WordPressはブログや管理インターフェイス上で、メディアアイコンを使って添付ファイルを表すことができます。画像の場合はサムネイルが表示されますが、その他のメディアタイプはその種類の名前がついたイメージファイル (例: audio.jpg) を wp-includes/images/crystal/ ディレクトリから検索します。

この例は、先のディレクトリをどのように"images"フォルダーへ変更するのかという手順を、wp-content/themes/yourtheme/imagesというテーマを例に説明しています。フォルダを作成し、 "media type images" を記載してください。WordPressにディレクトリが変更したことを通知するためには、使用中であるテーマの functions.php ファイルにこれを書き込んでください。

add_filter( 'icon_dir', 'my_theme_icon_directory' );
add_filter( 'icon_dir_uri', 'my_theme_icon_uri' );

function my_theme_icon_directory( $icon_dir ) {
	return get_stylesheet_directory() . '/images';
}

function my_theme_icon_uri( $icon_dir ) {
	return get_stylesheet_directory_uri() . '/images'; 
}

投稿最初の画像を表示する

関数リファレンス/get_children()を参照してください。

変更履歴

2.5.0で導入されました。

ソースファイル

wp_get_attachment_image_src()wp-includes/media.php にあります。

添付ファイル関数: get_children(), get attached media(), the_attachment_link(), get_attachment_link(), wp_get_attachment_link(), wp_get_attachment_image(), wp_get_attachment_image_src(), wp_get_attachment_url(), wp_get_attachment_thumb_file(), wp_get_attachment_thumb_url(), is_attachment(), wp_get_attachment_metadata()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp get attachment image src最新版との差分