wp_get_attachment_link

（2.5.0以降）
wp_get_attachment_link - 添付ファイルへのリンクを示すHTMLテキストを取得する

説明

string wp_get_attachment_link( [ int $id = 0 [ , mixed $size = 'thumbnail' [ , bool $permalink = false [ , bool $icon = false [ , mixed $text = false ] ] ] ] ] )
添付ファイルへのリンクを示すHTMLテキストを取得する。

パラメータ

  • $id
    投稿情報IDを指定（省略時は0）
  • $size
    サイズとして'thumbnail'、'none'、数値の何れかを指定（省略時は'thumbnail'）
  • $permalink
    パーマリンクを使用する場合はtrue、使用しない場合はfalseを指定（省略時はfalse）
  • $icon
    アイコン画像を使用する場合はtrue、使用しない場合はfalseを指定（省略時はfalse）
  • $text
    見出し文字を指定（省略時はfalse）

返り値

添付ファイルへのリンクを含むHTMLテキストを返す。パラメータ$idで指定された投稿情報が添付ファイルでない（post_typeが'attachment'以外）か、URLが取得できなかった場合は、'Missing Attachment'の翻訳テキストを返す。

注意

パラメータ$textが指定された場合、$sizeや$iconの指定に関わらず、$textで指定した文字が有効になる（''が指定された場合は、投稿情報のタイトルが適用される）。

使用例

  • 添付ファイルの投稿情報IDが10のリンクを示すHTMLテキストを取得する。
    <?php $link = wp_get_attachment_link( 10 ); ?>

フィルター

[6.2.0]a要素を生成する前に'wp_get_attachment_link_attributes'フィルターを呼び出す。パラメータ$attributesは連想配列でデフォルトでは'href'キーにURLが指定されものとなり、$idには投稿IDが格納されている。 
$attributes = apply_filters( 'wp_get_attachment_link_attributes', $attributes, $id );
[2.7.0]生成したa要素（テキスト）を返す前に'wp_get_attachment_link'フィルターを呼び出す。パラメータ$link_htmlにはa要素（テキスト）が、$post、$size、$permalink、$icon、$textには本関数が受け取った内容が格納されている。 [5.1.0]パラメータ$attrが追加され、本関数が受け取った内容が格納されている。 
return apply_filters( 'wp_get_attachment_link', $link_html, $post, $size, $permalink, $icon, $text, $attr );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post-template.php

最終更新 : 2023年03月31日 10:51

関連

参考

Code Reference: wp_get_attachment_link

お勧め

edit_custom_thumbnail_sizesフィルターを使ってみた（2022年5月30日 更新）

アップロード済みの画像は、トリミングや回転、反転といった編集が可能である。6.0.0で追加されたedit_custom_thumbnail_sizesフィルターは、編集された内容を反映させるサイズを拡張するものだったので、さっそく使ってみた。

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧（2018年5月27日 更新）

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

投稿日の検索が自由自在に（2015年3月7日 更新）

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス（もちろん query_posts関数でも）で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

新テーマ「Twenty Twenty-Three」にはfunctions.phpがない（2022年10月6日 更新）

WordPress 6.1に同梱された新テーマ「Twenty Twenty-Three」を見てみると、そこには見慣れたfunctions.phpがない。Full Site Editing（FSE）対応テーマってこんな感じなのかと思いつつ、テーマの設定がどうなっているのか調べてみた。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。