テンプレートタグ/wp get attachment link

説明

以下のいずれかを含んだ、添付ファイルまたはページへのHTMLリンクを返す関数です。

1. 画像添付についてはいくつかの指定されたサイズ
2. 添付を意味する指定されたメディアアイコン
3. テキスト形式での添付タイトル
4. 自分自身で決めたテキスト

そのような添付が存在しない場合、関数は Missing Attachment の文字列を返します。

使い方

<?php wp_get_attachment_link( $id, $size, $permalink, $icon, $text ); ?>

デフォルトの使い方

<?php echo wp_get_attachment_link( 13 ); ?>

添付のID テンプレートの中に添付IDをダイナミックに取得する場合は、 get_children() などを用いるとよいでしょう。

パラメータ

$id

（整数） （Optional） 所望する添付のID。

初期値： ループ で使われる場合は、現状の投稿ID。(添付だけを表示するループである必要があります。)

$size

（文字列または配列） （Optional） 画像のサイズ。いづれかのキーワードとなる文字列 (thumbnail, medium, large, full)、または幅と高さをピクセルで表す配列で(例array(32,32))表します。Version 2.5以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。

初期値： 'thumbnail'

$permalink

（boolean） （Optional） 添付ファイルまたは画像への直リンク(Default)、または添付ページへのリンク。

初期値： 'False'

• 1 (True)
• 0 (False) - デフォルト

$icon

（boolean） （Optional） 添付を表すメディアアイコンを使用する。

初期値： 'False'

• 1 (True)
• 0 (False) - デフォルト

$text

（文字列） （Optional） 添付へのテキストリンクを表示させる。

初期値： 'false'

用例

中サイズの添付へのリンク

WordPressであなたがアップロードした画像のデフォルトサイズは、"サムネイル"、"中"、"大"、"フルサイズ"があります。画像サイズはWordPress管理画面の設定→メディア設定から変更可能です。

<?php 
    $id = 9; // 添付のID
    echo wp_get_attachment_link( $id, 'medium' ); 
?>

添付へのリンク

この例では、添付ページヘのリンクを表示します。

<?php 
    $id = 9; // 添付のID
    echo wp_get_attachment_link( $id, 'thumbnail', true ); 
?>

添付へのテキストリンク

この例では、添付ページヘ"My link text"という名前のリンクを表示します。

<?php 
    $id = 9; // 添付のID
    echo wp_get_attachment_link( $id, '' , false, false, 'My link text' ); 
?>

添付への投稿タイトルリンク

この例では、添付ファイルへの投稿タイトルのリンクを表示します。

<?php 
    $id = 9; // 添付のID
    echo wp_get_attachment_link( $id, '' ); 
 ?>

アイコンディレクトリを変更する

WordPressはブログや管理インターフェイス上で、メディアアイコンを使って添付ファイルを表すことができます。画像の場合はサムネイルが表示されますが、その他のメディアタイプはその種類の名前がついたイメージファイル (例: audio.jpg) を wp-includes/images/crystal/ ディレクトリから検索します。

この例は、先のディレクトリをどのように"images"フォルダーへ変更するのかという手順を、wp-content/themes/yourtheme/imagesというテーマを例に説明しています。フォルダを作成し、 "media type images" を記載してください。WordPressにディレクトリが変更したことを通知するためには、使用中であるテーマの functions.php ファイルにこれを書き込んでください。

add_filter( 'icon_dir', 'my_theme_icon_directory' );
add_filter( 'icon_dir_uri', 'my_theme_icon_uri' );

function my_theme_icon_directory( $icon_dir ) {
	return get_stylesheet_directory() . '/images';
}

function my_theme_icon_uri( $icon_dir ) {
	return get_stylesheet_directory_uri() . '/images'; 
}

注釈

リンクではなく画像だけが欲しい場合は、 wp_get_attachment_image() を用いてください。

変更履歴

2.5.0にて導入されました。

ソースファイル

wp_get_attachment_link() は wp-includes/post-template.php にあります。

関連資料

添付ファイル関数: get_children(), get attached media(), the_attachment_link(), get_attachment_link(), wp_get_attachment_link(), wp_get_attachment_image(), wp_get_attachment_image_src(), wp_get_attachment_url(), wp_get_attachment_thumb_file(), wp_get_attachment_thumb_url(), is_attachment(), wp_get_attachment_metadata()

最新英語版： WordPress Codex » Function Reference/wp get attachment link （最新版との差分）