当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「テンプレートタグ/wp get attachment image」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ)
 
(和訳完了)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
添付が存在する場合は、添付ファイルのページにHTMLのイメージエレメントを、無い場合は空の文字列を返します。
  
Returns an HTML image element representing an attachment file, if there is any, otherwise an empty string.
+
<div id="Usage">
 
+
== 使い方 ==
== Usage ==
+
</div>
 
+
  <?php wp_get_attachment_image( $attachment_id, $size, $icon, $attr ); ?>
  <?php wp_get_attachment_image( $attachment_id, $size, $icon, $attr ); ?>%%%
+
 
+
== Default Usage ==
+
  
 +
<div id="Default_usage">
 +
== デフォルトの使い方 ==
 +
</div>
 
  <?php echo wp_get_attachment_image( 1 ); ?>
 
  <?php echo wp_get_attachment_image( 1 ); ?>
  
If the attachment is an image, the function returns an image at the specified size.
+
もし添付がイメージである場合、指定されたサイズのイメージを返します。
For other attachments, the function returns a media icon if the <var>$icon</var> parameter is set to <tt>true</tt>.
+
その他の添付の場合、<var>$icon</var> パラメーターが <tt>true</tt> に指定されている場合、関数はメディアアイコンを返します。
  
To get attachment IDs dynamically in a template, you can use [[Template_Tags/get_posts|get_posts('post_type=attachment')]], etc.
+
テンプレートの中に添付IDをダイナミックに取得する場合は、 [[テンプレートタグ/get_posts|get_posts('post_type=attachment')]] などを用います。
  
== Parameters ==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
{{Parameter|$attachment_id|integer|所望する添付のID。}}
  
{{Parameter|$attachment_id|integer|ID of the desired attachment.}}
+
{{Parameter|$size|文字列または配列|イメージの大きさ。文字列のキーワード (thumbnail, medium, large, full)または2つのアイテムを持つ配列が幅と高さをピクセルで、<tt>array(32,32)</tt>という形で表します。[[Version 2.5]]以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。|Optional|'thumbnail'}}
  
{{Parameter|$size|string/array|Image size. 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'}}
+
全てのイメージサイズをチェックする必要がある文字列の代わりに、<code>add_image_size</code> を用いてサイズを登録することを考慮すると良いでしょう。これによって切り抜かれた版が生成されます。これは、最も近いサイズのイメージを探すより、遥かに効率的なやり方です。
  
Instead of using an array which requires checking all of the image sizes, you should consider registering a size with <code>add_image_size</code> so that a cropped version is generated.  It's much more efficient than having to find the closest sized image.
+
{{Parameter|$icon|boolean|添付を表すメディアアイコンを使用する。|Optional|'False'}}
 
+
{{Parameter|$icon|boolean|Use a media icon to represent the attachment.|Optional|'False'}}
+
 
:* <tt>1 (True)</tt>  
 
:* <tt>1 (True)</tt>  
:* <tt>0 (False)</tt> - Default
+
:* <tt>0 (False)</tt> - デフォルト
  
{{Parameter|$attr|string/array|Query string or array of attributes.|Optional}}
+
{{Parameter|$attr|属性の文字列または配列|検索文字列または配列|Optional}}
 
<pre>
 
<pre>
 
$default_attr = array(
 
$default_attr = array(
37行目: 41行目:
 
</pre>
 
</pre>
  
The <tt>$attr</tt> argument is merged with WordPress's default attributes and passed through the <tt>wp_get_attachment_image_attributes</tt> filter.
+
<tt>$attr</tt>の引数はWordPressのデフォルト引数に統合され、<tt>wp_get_attachment_image_attributes</tt>フィルタを通して渡されます。
 
+
== Examples ==
+
=== Display all images as a list ===
+
 
+
To display all of the images and titles attached to a certain page and display them as a list of bullets you can use the following:
+
  
 +
<div id="Examples">
 +
== 用例 ==
 +
</div>
 +
<div id="Display_all_images_as_a_list">
 +
=== 全てのイメージをリストとして表示する場合 ===
 +
</div>
 +
ページに添付されている全てのイメージとタイトルを表示し、箇条書きのリストとして表示する場合は、以下を用います。
 
<pre><ul>
 
<pre><ul>
 
<?php if ( have_posts() ) : while ( have_posts() ) : the_post();     
 
<?php if ( have_posts() ) : while ( have_posts() ) : the_post();     
68行目: 74行目:
 
</ul></pre>
 
</ul></pre>
  
== Return Value ==
+
<div id="Return_value">
an HTML img element or empty string on failure.
+
== 戻り値 ==
 +
</div>
 +
HTMLの<tt>img</tt>エレメントもしくは、失敗した場合は空の文字列が返されます。
  
== Change Log ==
+
<div id="Change_log">
Since: 2.5.0
+
== 変更履歴 ==
 +
</div>
 +
2.5.0にて導入されました。
  
== Source File ==
+
<div id="Source_file">
 
+
== ソースファイル ==
<tt>wp_get_attachment_image()</tt> is located in {{Trac|wp-includes/media.php}}.
+
</div>
 
+
<tt>wp_get_attachment_image()</tt> {{Trac|wp-includes/media.php}}にあります。
== Related ==
+
  
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 
{{Attachment Tags}}
 
{{Attachment Tags}}
  
 
{{Tag Footer}}
 
{{Tag Footer}}
 
+
{{原文|Function Reference/wp get attachment image|125179}}<!-- 23:30, 29 December 2012 SergeyBiryukov -->
[[Category:Functions]]
+
[[Category:関数]]
 
[[Category:New page created]]
 
[[Category:New page created]]

2013年6月22日 (土) 18:49時点における版

添付が存在する場合は、添付ファイルのページにHTMLのイメージエレメントを、無い場合は空の文字列を返します。

使い方

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

デフォルトの使い方

<?php echo wp_get_attachment_image( 1 ); ?>

もし添付がイメージである場合、指定されたサイズのイメージを返します。 その他の添付の場合、$icon パラメーターが true に指定されている場合、関数はメディアアイコンを返します。

テンプレートの中に添付IDをダイナミックに取得する場合は、 get_posts('post_type=attachment') などを用います。

パラメータ

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

全てのイメージサイズをチェックする必要がある文字列の代わりに、add_image_size を用いてサイズを登録することを考慮すると良いでしょう。これによって切り抜かれた版が生成されます。これは、最も近いサイズのイメージを探すより、遥かに効率的なやり方です。

$icon
boolean) (Optional) 添付を表すメディアアイコンを使用する。
初期値: 'False'
  • 1 (True)
  • 0 (False) - デフォルト
$attr
属性の文字列または配列) (Optional) 検索文字列または配列
初期値: なし
$default_attr = array(
	'src'	=> $src,
	'class'	=> "attachment-$size",
	'alt'   => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )),
);

$attrの引数はWordPressのデフォルト引数に統合され、wp_get_attachment_image_attributesフィルタを通して渡されます。

用例

全てのイメージをリストとして表示する場合

ページに添付されている全てのイメージとタイトルを表示し、箇条書きのリストとして表示する場合は、以下を用います。

<ul>
<?php if ( have_posts() ) : while ( have_posts() ) : the_post();    

 $args = array(
   'post_type' => 'attachment',
   'numberposts' => -1,
   'post_status' => null,
   'post_parent' => $post->ID
  );

  $attachments = get_posts( $args );
     if ( $attachments ) {
        foreach ( $attachments as $attachment ) {
           echo '<li>';
           echo wp_get_attachment_image( $attachment->ID, 'full' );
           echo '<p>';
           echo apply_filters( 'the_title', $attachment->post_title );
           echo '</p></li>';
          }
     }

 endwhile; endif; ?>
</ul>

戻り値

HTMLのimgエレメントもしくは、失敗した場合は空の文字列が返されます。

変更履歴

2.5.0にて導入されました。

ソースファイル

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