wp_get_attachment_image()


WordPressのwp_get_attachment_image()関数は、指定された添付ファイルIDの画像をHTMLのimgタグとして取得するために使用されます。この関数は、画像のサイズや属性を柔軟に指定することができます。

構文

wp_get_attachment_image( int $attachment_id, string|array $size = 'thumbnail', bool $icon = false, string|array $attr = '' );

引数の説明:

  • $attachment_id (int) — 画像の添付ファイルIDを指定します。
  • $size (string|array) — 画像のサイズを指定します。デフォルトは’thumbnail’です。
  • $icon (bool) — アイコンとして表示するかどうかを指定します。デフォルトはfalseです。
  • $attr (string|array)imgタグに追加する属性を指定します。

例1: サムネイルサイズの画像を表示

この例では、投稿の最初の画像をサムネイルサイズで表示します。

<?php echo wp_get_attachment_image( get_post_thumbnail_id( get_the_ID() ), 'thumbnail' ); ?>

例2: フルサイズの画像を表示

この例では、指定した添付ファイルIDの画像をフルサイズで表示します。

<?php echo wp_get_attachment_image( 123, 'full' ); ?>

例3: カスタム属性を追加

この例では、imgタグにカスタムのclassalt属性を追加します。

<?php echo wp_get_attachment_image( 123, 'medium', false, array( 'class' => 'custom-class', 'alt' => 'Custom Alt Text' ) ); ?>

例4: アイコンとして表示

この例では、添付ファイルをアイコンとして表示します。

<?php echo wp_get_attachment_image( 123, 'thumbnail', true ); ?>

例5: カスタムサイズの画像を表示

この例では、カスタムサイズの画像を表示します。

<?php echo wp_get_attachment_image( 123, array( 300, 200 ) ); ?>

例6: 投稿の最初の画像を表示

この例では、投稿に添付された最初の画像を表示します。

<?php $attachments = get_posts( array( 'post_type' => 'attachment', 'posts_per_page' => 1, 'post_parent' => get_the_ID() ) ); if ( $attachments ) { echo wp_get_attachment_image( $attachments[0]->ID, 'large' ); } ?>

例7: 画像にリンクを追加

この例では、画像にリンクを追加して表示します。

<?php $image = wp_get_attachment_image( 123, 'medium' ); if ( $image ) { echo '<a href="' . wp_get_attachment_url( 123 ) . '">' . $image . '</a>'; } ?>

注意点:

  • 添付ファイルIDが正しく指定されていない場合、画像は表示されません。
  • カスタム属性を追加する際は、HTMLの仕様に従って正しく記述してください。

関連機能: