wp_get_attachment_link()


関数wp_get_attachment_link()は、WordPressで添付ファイルのリンクを取得するために使用されます。この関数は、指定された添付ファイルIDに基づいてリンクを生成し、オプションでカスタムクラスやサイズを指定できます。

構文

wp_get_attachment_link( int $id, string|array $size = 'thumbnail', bool $permalink = false, bool $icon = false, string|false $text = false, array|string $attr = '' );

引数の説明:

  • $id(int) — 添付ファイルのIDを指定します。
  • $size(string|array) — 画像のサイズを指定します。デフォルトは’thumbnail’です。
  • $permalink(bool) — trueに設定すると、添付ファイルのページへのリンクを生成します。デフォルトはfalseです。
  • $icon(bool) — trueに設定すると、アイコンを表示します。デフォルトはfalseです。
  • $text(string|false) — リンクテキストを指定します。デフォルトはfalseで、添付ファイルのタイトルが使用されます。
  • $attr(array|string) — リンクに追加する属性を指定します。

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

この例では、添付ファイルのサムネイル画像へのリンクを表示します。

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

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

この例では、添付ファイルのフルサイズ画像へのリンクを表示します。

<?php echo wp_get_attachment_link( get_the_ID(), 'full' ); ?>

例3: カスタムリンクテキストを指定

この例では、カスタムリンクテキストを指定してリンクを生成します。

<?php echo wp_get_attachment_link( get_the_ID(), 'medium', false, false, '画像を表示' ); ?>

例4: アイコンを表示

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

<?php echo wp_get_attachment_link( get_the_ID(), 'thumbnail', false, true ); ?>

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

この例では、リンクにカスタム属性を追加します。

<?php echo wp_get_attachment_link( get_the_ID(), 'thumbnail', false, false, false, array( 'class' => 'custom-class' ) ); ?>

例6: 添付ファイルページへのリンクを生成

この例では、添付ファイルの詳細ページへのリンクを生成します。

<?php echo wp_get_attachment_link( get_the_ID(), 'thumbnail', true ); ?>

例7: 複数の属性を指定

この例では、複数の属性を指定してリンクを生成します。

<?php echo wp_get_attachment_link( get_the_ID(), 'thumbnail', false, false, false, array( 'class' => 'custom-class', 'data-id' => get_the_ID() ) ); ?>

注意点:

  • 添付ファイルIDが存在しない場合、関数は空の文字列を返します。
  • サイズ指定が無効な場合、デフォルトのサムネイルサイズが使用されます。
  • カスタム属性を指定する際は、正しい形式で指定する必要があります。

関連機能：