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

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。