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



お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。