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

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

「関数リファレンス/wp get attachment image src」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ)
 
(和訳完了。)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
添付された画像ファイルの"<tt>url</tt>"、"<tt>width</tt>"、"<tt>height</tt>"属性を配列として返す関数です。<br>
 +
'''注:''' 画像ソースのみの場合は、一番最初のエレメントを使ってください。
  
Returns an array with the image attributes "url", "width" and "height", of an image attachment file.<br>
+
<div id="Usage">
'''Note:''' For just the image src, use the first element in the returned array.
+
== 使い方 ==
 
+
</div>
== Usage ==
+
  
 
  <?php wp_get_attachment_image_src( $attachment_id, $size, $icon ); ?>
 
  <?php wp_get_attachment_image_src( $attachment_id, $size, $icon ); ?>
  
== Parameters ==
 
  
{{Parameter|$attachment_id|integer|ID of the desired attachment.}}
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
{{Parameter|$attachment_id|整数|所望する添付のID}}
  
{{Parameter|$size|string/array|Size of the image shown for an image attachment: either a string keyword (thumbnail, medium, large or full) or a 2-item array representing width and height in pixels, e.g. array(32,32). As of Version 2.5, this parameter does not affect the size of media icons, which are always shown at their original size.|optional|thumbnail}}
+
{{Parameter|$size|文字列/配列|画像の大きさ。キーワードとなる文字列 (<tt>thumbnail, medium, large, full</tt>)または2つのアイテムを持つ配列が幅と高さをピクセルで、array(32,32)という形で表します。Version 2.5以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。|optional|thumbnail}}
  
{{Parameter|$icon|bool|Use a media icon to represent the attachment.|optional|false}}
+
{{Parameter|$icon|boolean|添付を表すメディアアイコンを使用する。|optional|false}}
  
== Return Value ==
+
<div id="Return_value">
; (array): An array containing:
+
== 戻り値 ==
 +
</div>
 +
; (配列): 配列は以下を含みます:
 
* [0] => url
 
* [0] => url
 
* [1] => width
 
* [1] => width
 
* [2] => height
 
* [2] => height
  
or false, if no image is available.
+
画像でない場合は、 <tt>false</tt> を返します。
  
== Examples ==
+
<div id="Examples">
=== Default Usage ===
+
== 用例 ==
 +
</div>
 +
<div id="Default_usage">
 +
=== デフォルトの使い方 ===
 +
</div>
 
<pre><?php  
 
<pre><?php  
$attachment_id = 8; // attachment ID
+
$attachment_id = 8; // 添付ID
  
$image_attributes = wp_get_attachment_image_src( $attachment_id ); // returns an array
+
$image_attributes = wp_get_attachment_image_src( $attachment_id ); // 配列を返す
 
?>  
 
?>  
 
   
 
   
 
<img src="<?php echo $image_attributes[0]; ?>" width="<?php echo $image_attributes[1]; ?>" height="<?php echo $image_attributes[2]; ?>"></pre>
 
<img src="<?php echo $image_attributes[0]; ?>" width="<?php echo $image_attributes[1]; ?>" height="<?php echo $image_attributes[2]; ?>"></pre>
  
=== Change Icon Directory ===
+
<div id="Change Icon Directory">
 +
=== アイコンディレクトリを変更する ===
 +
</div>
 +
WordPressはブログや管理インターフェイス上で、メディアアイコンを使って[[Using_Image_and_File_Attachments|添付ファイル]]を表すことができます。画像の場合はサムネイルが表示されますが、その他のメディアタイプはその種類の名前がついたイメージファイル (例: audio.jpg) を ''wp-includes/images/crystal/'' ディレクトリから検索します。
  
WordPress can use media icons to represent [[Using_Image_and_File_Attachments|attachment files]] on your blog and in the Admin interface, if those icons are available. For images it returns the thumbnail. For other media types It looks for image files named by media type (e.g. audio.jpg) in the directory: ''wp-includes/images/crystal/''.
+
この例は、先のディレクトリをどのように"images"フォルダーへ変更するのかという手順を、''wp-content/themes/yourtheme/images''というテーマを例に説明しています。フォルダを作成し、 "media type images" を記載してください。WordPressにディレクトリが変更したことを通知するためには、使用中であるテーマの [[Theme_Development#Functions_File|functions.php]] ファイルにこれを書き込んでください。
 
+
This example shows how you can change this directory to a folder called "images" in your theme: ''wp-content/themes/yourtheme/images''. Create the folder and put the "media type images" in there. To tell WordPress the directory has changed put this in the current theme's [[Theme_Development#Functions_File|functions.php]] file:
+
  
 
<pre>add_filter( 'icon_dir', 'my_theme_icon_directory' );
 
<pre>add_filter( 'icon_dir', 'my_theme_icon_directory' );
52行目: 64行目:
 
</pre>
 
</pre>
  
=== Show the first image of the post ===
+
<div id="Show the first image of the post">
find the full code here [[Function Reference/get_children#Examples|get_children()]].
+
=== 投稿最初の画像を表示する ===
 
+
</div>
== Change Log  ==
+
関数リファレンス/[[関数リファレンス/get_children#Examples|get_children()]]を参照してください。
 
+
Since: [[Version 2.5|2.5.0]]
+
 
+
== Source File ==
+
 
+
<tt>wp_get_attachment_image_src()</tt> is located in {{Trac|wp-includes/media.php}}.
+
 
+
== Description ==
+
 
+
Returns an array with the image attributes "url", "width" and "height", of an image attachment file.<br>
+
'''Note:''' For just the image src, use the first element in the returned array.
+
 
+
== Usage ==
+
 
+
%%% <?php wp_get_attachment_image_src( $attachment_id, $size, $icon ); ?> %%%
+
 
+
== Parameters ==
+
 
+
{{Parameter|$attachment_id|integer|ID of the desired attachment.}}
+
 
+
{{Parameter|$size|string/array|Size of the image shown for an image attachment: either a string keyword (thumbnail, medium, large or full) or a 2-item array representing width and height in pixels, e.g. array(32,32). As of Version 2.5, this parameter does not affect the size of media icons, which are always shown at their original size.|optional|thumbnail}}
+
 
+
{{Parameter|$icon|bool|Use a media icon to represent the attachment.|optional|false}}
+
 
+
== Return Value ==
+
; (array):  An array containing:
+
* [0] => url
+
* [1] => width
+
* [2] => height
+
 
+
or false, if no image is available.
+
 
+
== Examples ==
+
=== Default Usage ===
+
<pre><?php
+
$attachment_id = 8; // attachment ID
+
 
+
$image_attributes = wp_get_attachment_image_src( $attachment_id ); // returns an array
+
?>  
+
+
<img src="<?php echo $image_attributes[0]; ?>" width="<?php echo $image_attributes[1]; ?>" height="<?php echo $image_attributes[2]; ?>"></pre>
+
 
+
=== Change Icon Directory ===
+
 
+
WordPress can use media icons to represent [[Using_Image_and_File_Attachments|attachment files]] on your blog and in the Admin interface, if those icons are available. For images it returns the thumbnail. For other media types It looks for image files named by media type (e.g. audio.jpg) in the directory: ''wp-includes/images/crystal/''.
+
 
+
This example shows how you can change this directory to a folder called "images" in your theme: ''wp-content/themes/yourtheme/images''. Create the folder and put the "media type images" in there. To tell WordPress the directory has changed put this in the current theme's [[Theme_Development#Functions_File|functions.php]] file:
+
 
+
<pre>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';
+
}
+
</pre>
+
 
+
=== Show the first image of the post ===
+
find the full code here [[Function Reference/get_children#Examples|get_children()]].
+
 
+
== Change Log  ==
+
 
+
Since: [[Version 2.5|2.5.0]]
+
  
== Source File ==
+
<div id="Change_log">
 +
== 変更履歴 ==
 +
</div>
 +
2.5.0てに導入されました。
  
<tt>wp_get_attachment_image_src()</tt> is located in {{Trac|wp-includes/media.php}}.
+
<div id="Source_file">
 +
== ソースファイル ==
 +
</div>
 +
<tt>wp_get_attachment_image_src()</tt> {{Trac|wp-includes/media.php}} にあります。
  
 
<div id="Related">
 
<div id="Related">

2013年7月1日 (月) 04:45時点における版

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

使い方

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


パラメータ

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

戻り値

(配列)
配列は以下を含みます:
  • [0] => url
  • [1] => width
  • [2] => height

画像でない場合は、 false を返します。

用例

デフォルトの使い方

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

$image_attributes = wp_get_attachment_image_src( $attachment_id ); // 配列を返す
?> 
 
<img src="<?php echo $image_attributes[0]; ?>" width="<?php echo $image_attributes[1]; ?>" height="<?php echo $image_attributes[2]; ?>">

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

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最新版との差分


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