the_attachment_link()


関数the_attachment_link()は、WordPressで添付ファイルのリンクを表示するために使用されます。この関数は、添付ファイルのURLとタイトルをリンクとして出力します。

構文

the_attachment_link( int|WP_Post $id = 0, bool $permalink = false, bool $icon = false, string $text = false, bool $deprecated = false );

引数の説明:

  • $id(int|WP_Post) — 添付ファイルのIDまたはWP_Postオブジェクト。デフォルトは0。
  • $permalink(bool) — trueの場合、添付ファイルのページへのリンクを表示。falseの場合、ファイル自体へのリンクを表示。デフォルトはfalse。
  • $icon(bool) — trueの場合、アイコンを表示。デフォルトはfalse。
  • $text(string) — リンクテキスト。デフォルトはfalse。
  • $deprecated(bool) — 非推奨の引数。デフォルトはfalse。

例 1: 基本的な添付ファイルリンクの表示

このコードは、添付ファイルのリンクを表示します。

<?php the_attachment_link( get_the_ID(), false ); ?>

例 2: 添付ファイルのページへのリンクを表示

このコードは、添付ファイルのページへのリンクを表示します。

<?php the_attachment_link( get_the_ID(), true ); ?>

例 3: アイコン付きで添付ファイルリンクを表示

このコードは、アイコン付きで添付ファイルのリンクを表示します。

<?php the_attachment_link( get_the_ID(), false, true ); ?>

例 4: カスタムテキストで添付ファイルリンクを表示

このコードは、カスタムテキストを使用して添付ファイルのリンクを表示します。

<?php the_attachment_link( get_the_ID(), false, false, 'ダウンロード' ); ?>

例 5: 特定の添付ファイルIDを使用してリンクを表示

このコードは、特定の添付ファイルIDを使用してリンクを表示します。

<?php the_attachment_link( 123, false ); ?>

例 6: アイコンとカスタムテキストを組み合わせて表示

このコードは、アイコンとカスタムテキストを組み合わせて添付ファイルのリンクを表示します。

<?php the_attachment_link( get_the_ID(), false, true, 'ファイルをダウンロード' ); ?>

注意点:

  • $idが正しく設定されていない場合、リンクが正しく表示されない可能性があります。
  • $permalinkをtrueに設定すると、添付ファイルのページにリダイレクトされます。
  • $iconをtrueに設定すると、ファイルタイプに応じたアイコンが表示されます。

関連機能：