wp_get_attachment_link

説明

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



お勧め

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

3.6リリース直前チェック(2013年7月26日 更新)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

投稿画面のウェジェットを2列にする(2013年4月17日 更新)

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。