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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ)
 
 
(3人の利用者による、間の5版が非表示)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
Returns an HTML image element representing an attachment file, if there is any, otherwise an empty string.
+
添付ファイルが存在する場合はそれを表す HTML の img 要素を、ない場合は空の文字列を返します。
  
== Usage ==
+
<div id="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|<code>get_posts( 'post_type=attachment' )</code>]] などを用います。
  
== Parameters ==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|$attachment_id|integer|ID of the desired attachment.}}
+
{{Parameter|$attachment_id|整数|添付ファイルの ID。}}
  
{{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'}}
+
{{Parameter|$size|文字列&#124;配列|画像の大きさ。キーワードとなる文字列(<tt>thumbnail</tt>, <tt>medium</tt>, <tt>large</tt>, <tt>full</tt>)、または [[関数リファレンス/add image size|<tt>add_image_size()</tt>]] で定義したカスタムサイズのキーワード、もしくは幅と高さをピクセルで指定する要素 2 つの配列、例えば <code>array( 32, 32 )</code>。[[Version 2.5]] 以降、このパラメータはメディアアイコンの大きさを変えることができず、常に元の大きさで表示される。|オプション|<tt>'thumbnail'</tt>}}
  
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.
+
:'''参考:''' 全ての画像サイズをチェックする必要がある配列形式の代わりに、<code>add_image_size</code> を用いてサイズを登録することを考慮すると良いでしょう。これによって指定のサイズに切り抜かれた版が生成されます。これは、最も近いサイズの画像を探すより、遥かに効率的なやり方です。
  
{{Parameter|$icon|boolean|Use a media icon to represent the attachment.|Optional|'False'}}
+
{{Parameter|$icon|真偽値|添付ファイルを表すメディアアイコンを使用する。|オプション|'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|文字列&#124;配列|属性を表すクエリ形式の文字列または配列。|オプション|下記参照。}}
 
<pre>
 
<pre>
 
$default_attr = array(
 
$default_attr = array(
'src' => $src,
+
    'src'   => $src,
'class' => "attachment-$size",
+
    'class' => "attachment-$size",
'alt'  => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )),
+
    'alt'  => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) ),
 
);
 
);
 
</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 ==
+
<div id="Examples">
=== Display all images as a list ===
+
== 用例 ==
 +
</div>
  
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:  
+
例えば次のような文字列が返されます。
 +
 
 +
<pre>
 +
<img width="150" height="150" src="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg" class="attachment-thumbnail size-thumbnail" alt="" srcset="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg 150w, http://example.com/wp-content/uploads/2017/11/image-xyz-50x50.jpg 50w" sizes="(max-width: 150px) 100vw, 150px" />
 +
</pre>
 +
 
 +
<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();     
  
$args = array(
+
  $args = array(
  'post_type' => 'attachment',
+
    'post_type'   => 'attachment',
  'numberposts' => -1,
+
    'numberposts' => -1,
  'post_status' => null,
+
    'post_status' => null,
  'post_parent' => $post->ID
+
    'post_parent' => $post->ID
 
   );
 
   );
  
 
   $attachments = get_posts( $args );
 
   $attachments = get_posts( $args );
    if ( $attachments ) {
+
  if ( $attachments ) {
        foreach ( $attachments as $attachment ) {
+
    foreach ( $attachments as $attachment ) {
          echo '<li>';
+
      echo '<li>';
          echo wp_get_attachment_image( $attachment->ID, 'full' );
+
      echo wp_get_attachment_image( $attachment->ID, 'full' );
          echo '<p>';
+
      echo '<p>';
          echo apply_filters( 'the_title', $attachment->post_title );
+
      echo apply_filters( 'the_title', $attachment->post_title );
          echo '</p></li>';
+
      echo '</p></li>';
          }
+
    }
    }
+
  }
  
endwhile; endif; ?>
+
endwhile; endif; ?>
 
</ul></pre>
 
</ul></pre>
  
== Return Value ==
+
<div id="Return_value">
an HTML img element or empty string on failure.
+
== 戻り値 ==
 +
</div>
  
== Change Log ==
+
HTML の <tt>img</tt> 要素。失敗した場合は空の文字列を返します。
Since: 2.5.0
+
  
== Source File ==
+
<div id="Change_log">
 +
== 変更履歴 ==
 +
</div>
  
<tt>wp_get_attachment_image()</tt> is located in {{Trac|wp-includes/media.php}}.
+
新規導入: 2.5.0
  
== Related ==
+
<div id="Source_file">
 +
== ソースファイル ==
 +
</div>
  
{{Attachment Tags}}
+
<tt>wp_get_attachment_image()</tt> は {{Trac|wp-includes/media.php}} にあります。
  
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
 +
{{Attachment Tags}}
 
{{Tag Footer}}
 
{{Tag Footer}}
  
[[Category:Functions]]
+
{{原文|Function Reference/wp get attachment image|137925}} <!-- 12:24, 10 November 2013 Mistercat 版 -->
[[Category:New page created]]
+
 
 +
{{DEFAULTSORT:Wp_get_attachment_image}}
 +
[[Category:添付ファイル]]
 +
 
 +
[[en:Function Reference/wp get attachment image]]
 +
[[it:Riferimento funzioni/wp get attachment image]]

2018年7月30日 (月) 20:05時点における最新版

添付ファイルが存在する場合はそれを表す HTML の img 要素を、ない場合は空の文字列を返します。

使い方

<?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
整数) (必須) 添付ファイルの ID。
初期値: なし
$size
文字列|配列) (オプション) 画像の大きさ。キーワードとなる文字列(thumbnail, medium, large, full)、または add_image_size() で定義したカスタムサイズのキーワード、もしくは幅と高さをピクセルで指定する要素 2 つの配列、例えば array( 32, 32 )Version 2.5 以降、このパラメータはメディアアイコンの大きさを変えることができず、常に元の大きさで表示される。
初期値: 'thumbnail'
参考: 全ての画像サイズをチェックする必要がある配列形式の代わりに、add_image_size を用いてサイズを登録することを考慮すると良いでしょう。これによって指定のサイズに切り抜かれた版が生成されます。これは、最も近いサイズの画像を探すより、遥かに効率的なやり方です。
$icon
真偽値) (オプション) 添付ファイルを表すメディアアイコンを使用する。
初期値: 'False'
  • 1 (True) - 使用する
  • 0 (False) - 使用しない
$attr
文字列|配列) (オプション) 属性を表すクエリ形式の文字列または配列。
初期値: 下記参照。
$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 フィルターを通して渡されます。

用例

例えば次のような文字列が返されます。

<img width="150" height="150" src="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg" class="attachment-thumbnail size-thumbnail" alt="" srcset="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg 150w, http://example.com/wp-content/uploads/2017/11/image-xyz-50x50.jpg 50w" sizes="(max-width: 150px) 100vw, 150px" />

全ての画像をリストとして表示する場合

あるページに添付されている全ての画像とタイトルを箇条書きのリストとして表示するには、次のコードを用います:

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