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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。