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

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

「関数リファレンス/is attachment」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(和訳完了)
(和訳完了)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
 
+
添付が存在する場合は、添付ファイルのページにHTMLのイメージエレメントを、無い場合は空の文字列を返します。
この [[条件分岐タグ|条件分岐タグ]] は、添付が表示されているかどうかをチェックします。添付とはアップロードユーティリティーからアップロードされたイメージや他のファイルを指します。添付は「ページ」またはテンプレートの上に表示されます。詳しくは、[[イメージとファイル添付を使う方法]]を参照してください。
+
 
+
これはboolean関数なので、戻り値は''TRUE''か''FALSE''です。
+
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
  <?php is_attachment(); ?>
+
  <?php wp_get_attachment_image( $attachment_id, $size, $icon, $attr ); ?>
 +
 
 +
<div id="Default_usage">
 +
== デフォルトの使い方 ==
 +
</div>
 +
<?php echo wp_get_attachment_image( 1 ); ?>
 +
 
 +
もし添付がイメージである場合、指定されたサイズのイメージを返します。
 +
その他の添付の場合、<var>$icon</var> パラメーターが <tt>true</tt> に指定されている場合、関数はメディアアイコンを返します。
 +
 
 +
テンプレートの中に添付IDをダイナミックに取得する場合は、 [[テンプレートタグ/get_posts|get_posts('post_type=attachment')]] などを用います。
  
 
<div id="Parameters">
 
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
 +
{{Parameter|$attachment_id|integer|所望する添付のID。}}
  
<div id="Return_Values">
+
{{Parameter|$size|文字列または配列|イメージの大きさ。文字列のキーワード (thumbnail, medium, large, full)または2つのアイテムを持つ配列が幅と高さをピクセルで、<tt>array(32,32)</tt>という形で表します。[[Version 2.5]]以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。|Optional|'thumbnail'}}
== 戻り値 ==
+
 
</div>
+
全てのイメージサイズをチェックする必要がある文字列の代わりに、<code>add_image_size</code> を用いてサイズを登録することを考慮すると良いでしょう。これによって切り抜かれた版が生成されます。これは、最も近いサイズのイメージを探すより、遥かに効率的なやり方です。
; <tt>(boolean)</tt> : 添付を表示している場合は <tt>true</tt>,それ以外は <tt>false</tt>
+
 
 +
{{Parameter|$icon|boolean|添付を表すメディアアイコンを使用する。|Optional|'False'}}
 +
:* <tt>1 (True)</tt>  
 +
:* <tt>0 (False)</tt> - デフォルト
 +
 
 +
{{Parameter|$attr|属性の文字列または配列|検索文字列または配列|Optional}}
 +
<pre>
 +
$default_attr = array(
 +
'src' => $src,
 +
'class' => "attachment-$size",
 +
'alt'  => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )),
 +
);
 +
</pre>
 +
 
 +
<tt>$attr</tt>の引数はWordPressのデフォルト引数に統合され、<tt>wp_get_attachment_image_attributes</tt>フィルタを通して渡されます。
  
 
<div id="Examples">
 
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
 
</div>
 
</div>
<pre>
+
<div id="Display_all_images_as_a_list">
&lt;?php
+
=== 全てのイメージをリストとして表示する場合 ===
if ( is_attachment() ) {
+
</div>
// show adv. #1
+
ページに添付されている全てのイメージとタイトルを表示し、箇条書きのリストとして表示する場合は、以下を用います。
} else {
+
<pre><ul>
// show adv. #2
+
<?php if ( have_posts() ) : while ( have_posts() ) : the_post();  
}
+
?&gt;
+
</pre>
+
  
<div id="Notes">
+
$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></pre>
 +
 
 +
<div id="Return_value">
 +
== 戻り値 ==
 
</div>
 
</div>
* [[関数リファレンス/is singular|is_singular()]]も参照してください。
+
HTMLの<tt>img</tt>エレメントもしくは、失敗した場合は空の文字列が返されます。
* より特定の添付をチェックするためには、[[関数リファレンス/wp attachment is image]]を参照してください。
+
  
<div id="Change_Log">
+
<div id="Change_log">
 
== 変更履歴 ==
 
== 変更履歴 ==
 
</div>
 
</div>
* 2.0.0より導入
+
2.5.0にて導入されました。
  
<div id="Source_File">
+
<div id="Source_file">
 
== ソースファイル ==
 
== ソースファイル ==
 
</div>
 
</div>
<!-- Need links to current source code files -->
+
<tt>wp_get_attachment_image()</tt> は {{Trac|wp-includes/media.php}}にあります。
<tt>is_attachment()</tt>は{{Trac|wp-includes/query.php}}に含まれています。
+
  
<div id="Related">
 
 
== 関連資料 ==
 
== 関連資料 ==
 
</div>
 
</div>
 
+
{{Attachment Tags}}
{{Conditional Tags}}
+
  
 
{{Tag Footer}}
 
{{Tag Footer}}
{{原文|Function Reference/is attachment|126756}}<!-- 21:27, 6 February 2013 Bcworkz -->
+
{{原文|Function Reference/wp get attachment image|125179}}<!-- 23:30, 29 December 2012 SergeyBiryukov -->
[[Category:条件分岐タグ]]
+
 
[[Category:関数]]
 
[[Category:関数]]
 +
[[Category:New page created]]

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

添付が存在する場合は、添付ファイルのページに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にあります。

関連資料

</div> 添付ファイル関数: 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最新版との差分