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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(関連資料: DEFAULTSORT と Category を追加。)
(和訳の見直し。)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
添付が存在する場合は、添付ファイルのページにHTMLの画像エレメントを、無い場合は空の文字列を返します。
+
 
 +
添付ファイルが存在する場合はそれを表す HTML の img 要素を、ない場合は空の文字列を返します。
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
 +
 
  <?php wp_get_attachment_image( $attachment_id, $size, $icon, $attr ); ?>
 
  <?php wp_get_attachment_image( $attachment_id, $size, $icon, $attr ); ?>
  
12行目: 14行目:
 
== デフォルトの使い方 ==
 
== デフォルトの使い方 ==
 
</div>
 
</div>
 +
 
  <?php echo wp_get_attachment_image( 1 ); ?>
 
  <?php echo wp_get_attachment_image( 1 ); ?>
  
もし添付が画像である場合、指定されたサイズの画像を返します。
+
添付ファイルが画像である場合、この関数は指定されたサイズの画像を返します。
その他の添付の場合、<var>$icon</var> パラメーターが <tt>true</tt> に指定されている場合、関数はメディアアイコンを返します。
+
他の種類の場合は、<var>$icon</var> パラメータが <tt>true</tt> であるときのみメディアアイコンを返します。
  
テンプレートの中に添付IDをダイナミックに取得する場合は、 [[テンプレートタグ/get_posts|get_posts('post_type=attachment')]] などを用います。
+
テンプレート内で添付ファイルの ID を動的に取得する場合は [[テンプレートタグ/get_posts|<code>get_posts( 'post_type=attachment' )</code>]] などを用います。
  
 
<div id="Parameters">
 
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
{{Parameter|$attachment_id|integer|所望する添付のID。}}
 
  
{{Parameter|$size|文字列または配列|画像の大きさ。キーワードとなる文字列 (thumbnail, medium, large, full)または2つのアイテムを持つ配列が幅と高さをピクセルで、<tt>array(32,32)</tt>という形で表します。[[Version 2.5]]以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。|Optional|'thumbnail'}}
+
{{Parameter|$attachment_id|整数|添付ファイルの ID。}}
  
全ての画像サイズをチェックする必要がある文字列の代わりに、<code>add_image_size</code> を用いてサイズを登録することを考慮すると良いでしょう。これによって切り抜かれた版が生成されます。これは、最も近いサイズの画像を探すより、遥かに効率的なやり方です。
+
{{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>}}
  
{{Parameter|$icon|boolean|添付を表すメディアアイコンを使用する。|Optional|'False'}}
+
:'''参考:''' 全ての画像サイズをチェックする必要がある配列形式の代わりに、<code>add_image_size</code> を用いてサイズを登録することを考慮すると良いでしょう。これによって指定のサイズに切り抜かれた版が生成されます。これは、最も近いサイズの画像を探すより、遥かに効率的なやり方です。
:* <tt>1 (True)</tt>
+
:* <tt>0 (False)</tt> - デフォルト
+
  
{{Parameter|$attr|属性の文字列または配列|検索文字列または配列|Optional}}
+
{{Parameter|$icon|真偽値|添付ファイルを表すメディアアイコンを使用する。|オプション|'False'}}
 +
:* <tt>1 (True)</tt> - 使用する
 +
:* <tt>0 (False)</tt> - 使用しない
 +
 
 +
{{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>
  
<tt>$attr</tt>の引数はWordPressのデフォルト引数に統合され、<tt>wp_get_attachment_image_attributes</tt>フィルタを通して渡されます。
+
:'''参考:''' <tt>$attr</tt> 引数は WordPress のデフォルトの属性に統合された後、<tt>wp_get_attachment_image_attributes</tt> フィルターを通して渡されます。
  
 
<div id="Examples">
 
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
 
</div>
 
</div>
 +
 
<div id="Display_all_images_as_a_list">
 
<div id="Display_all_images_as_a_list">
 
=== 全ての画像をリストとして表示する場合 ===
 
=== 全ての画像をリストとして表示する場合 ===
 
</div>
 
</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>
  
77行目: 84行目:
 
== 戻り値 ==
 
== 戻り値 ==
 
</div>
 
</div>
HTMLの<tt>img</tt>エレメントもしくは、失敗した場合は空の文字列が返されます。
+
 
 +
HTML の <tt>img</tt> 要素。失敗した場合は空の文字列を返します。
  
 
<div id="Change_log">
 
<div id="Change_log">
 
== 変更履歴 ==
 
== 変更履歴 ==
 
</div>
 
</div>
2.5.0にて導入されました。
+
 
 +
新規導入: 2.5.0
  
 
<div id="Source_file">
 
<div id="Source_file">
 
== ソースファイル ==
 
== ソースファイル ==
 
</div>
 
</div>
<tt>wp_get_attachment_image()</tt> は {{Trac|wp-includes/media.php}}にあります。
+
 
 +
<tt>wp_get_attachment_image()</tt> は {{Trac|wp-includes/media.php}} にあります。
  
 
<div id="Related">
 
<div id="Related">
96行目: 106行目:
 
{{Tag Footer}}
 
{{Tag Footer}}
  
{{原文|Function Reference/wp get attachment image|125179}}<!-- 23:30, 29 December 2012 SergeyBiryukov -->
+
{{原文|Function Reference/wp get attachment image|137925}} <!-- 12:24, 10 November 2013 Mistercat 版 -->
  
 
{{DEFAULTSORT:Wp_get_attachment_image}}
 
{{DEFAULTSORT:Wp_get_attachment_image}}
 
[[Category:添付ファイル]]
 
[[Category:添付ファイル]]
 +
 +
[[en:Function Reference/wp get attachment image]]
 +
[[it:Riferimento funzioni/wp get attachment image]]

2015年9月8日 (火) 00:28時点における版

添付ファイルが存在する場合はそれを表す 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 フィルターを通して渡されます。

用例

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

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

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