当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「テンプレートタグ/wp get attachment link」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/wp get attachment link 22:07, 4 November 2017 Tazotodua 版を反映。)
 
(3人の利用者による、間の3版が非表示)
1行目: 1行目:
== Description ==
+
== 説明<span id="Description"></span> ==
  
Returns an HTML hyperlink to an attachment file or page, containing either
+
添付ファイルまたはページへの HTML リンクを返します。次のいずれかを含みます。
  
# An image at some specified size, for image attachments; or
+
# 添付ファイルが画像のとき、指定されたサイズの画像
# A media icon (as specified) representing the attachment; or
+
# 添付ファイルを表すメディアアイコン (指定されたとき)
# The attachment's title (as text) or
+
# 添付ファイルのタイトル (テキスト)
# Your own text
+
# 自分で決めたテキスト
  
If no such attachment exists, the function returns the string <tt>Missing Attachment</tt>.
+
指定された添付ファイルが存在しない場合、文字列「<tt>添付ファイルが見つかりません</tt> (<tt>Missing Attachment</tt>)」を返します。
  
== Usage ==
+
== 使い方<span id="Usage"></span> ==
  
%%%<?php wp_get_attachment_link( $id, $size, $permalink, $icon, $text ); ?>%%%
+
<?php wp_get_attachment_link( $id, $size, $permalink, $icon, $text, $attr ); ?>
  
== Default Usage ==
+
=== デフォルトの使い方<span id="Default_Usage"></span> ===
  
 
  <?php echo wp_get_attachment_link( 13 ); ?>
 
  <?php echo wp_get_attachment_link( 13 ); ?>
  
To get attachment IDs dynamically in a template, you would probably use something like <tt>[[Function_Reference/get_children|get_children()]]</tt>.
+
テンプレート内で添付ファイルの ID を動的に取得するには、<tt>[[関数リファレンス/get_children|get_children()]]</tt> などを使うとよいでしょう。
  
== Parameters ==
+
== パラメータ<span id="Parameters"></span> ==
{{Parameter|$id|integer|ID of the desired attachment.|Optional|The current post ID, when used in [[The Loop]] (Must be a loop showing only attachments).}}
+
{{Parameter|$size|string/array|Image size. Either a string keyword (thumbnail, medium, large or full) or a 2-item array representing width and height in pixels, e.g. array(32,32). As of [[Version 2.5]], this parameter does not affect the size of media icons, which are always shown at their original size.|Optional|'thumbnail'}}
+
{{Parameter|$permalink|boolean|Link directly to the attachment file/image (<tt>Default</tt>), or to the attachment page. |Optional|'False'}}
+
:* <tt>1 (True)</tt>
+
:* <tt>0 (False)</tt> - Default
+
{{Parameter|$icon|boolean|Use a media icon to represent the attachment.|Optional|'False'}}
+
:* <tt>1 (True)</tt>
+
:* <tt>0 (False)</tt> - Default
+
{{Parameter|$text|string|Displays a text link to the attachment.|Optional|'false'}}
+
==Examples==
+
  
=== Show Medium Size Attachment. ===
+
{{Parameter|$id|整数|取得したい添付ファイルの ID。|オプション|[[ループ]]内で使った場合、現在の投稿 ID (添付ファイルだけを表示するループである必要があります)。}}
 +
{{Parameter|$size|文字列&#124;配列|画像の大きさ。キーワードとなる文字列(<tt>thumbnail</tt>, <tt>medium</tt>, <tt>large</tt>, <tt>full</tt>)、または [[関数リファレンス/add image size|<tt>add_image_size()</tt>]] で定義したカスタムサイズのキーワード、もしくは幅と高さをピクセルで指定する要素 2 つの配列、例えば <code>array( 32, 32 )</code>。[[Version 2.5]] 以降、このパラメータはメディアアイコンの大きさを変えることができず、常に元の大きさで表示されます。|オプション|<tt>'thumbnail'</tt>}}
 +
{{Parameter|$permalink|真偽値|添付ファイルや画像への直リンク (デフォルトまたは <tt>false</tt>)、または添付ページへのリンク (<tt>true</tt>)。|オプション|'false'}}
 +
{{Parameter|$icon|真偽値|添付ファイルを表すメディアアイコンを使う (<tt>true</tt> のとき)。|オプション|'false'}}
 +
{{Parameter|$text|文字列/真偽値|添付へのテキストリンクを表示する (空ではない文字列を指定したとき)。|オプション|'false'}}
 +
{{Parameter|$attr|文字列/配列|<tt>[[テンプレートタグ/wp get attachment image|wp_get_attachment_image()]]</tt> へ渡す画像属性のリスト。|オプション|空文字列}}
  
The default image sizes of WordPress are "thumbnail", "medium", "large" and "full" (the image you uploaded). These image sizes can be configured in the WordPress Administration [[Settings Media SubPanel|Media panel]] under Settings > Media.
+
== 用例<span id="Examples"></span> ==
  
<pre><?php  
+
例えば次のような形式の文字列を返します。
     $id = 9; // ID of an attachment
+
<pre>
 +
<a href='http://example.com/wp-content/uploads/2017/11/image-xyz.jpg'><img width="150" height="150" src="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg" class="attachment-thumbnail size-thumbnail" alt="" srcset="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg 150w, http://example.com/wp-content/uploads/2017/11/image-xyz-50x50.jpg 50w" sizes="(max-width: 150px) 100vw, 150px" /></a>
 +
</pre>
 +
 
 +
=== 中サイズの添付へのリンク<span id="Show_medium_size_attachment"></span> ===
 +
 
 +
WordPress のデフォルトの画像サイズは <tt>"thumbnail"</tt> (サムネイル)、<tt>"medium"</tt> (中)、<tt>"large"</tt> (大)、<tt>"full"</tt> (フルサイズ) です。画像サイズは WordPress 管理画面の設定→[[Settings Media SubPanel|メディア設定]]から変更できます。
 +
 
 +
<pre><?php  
 +
     $id = 9; // 添付の ID
 
     echo wp_get_attachment_link( $id, 'medium' );  
 
     echo wp_get_attachment_link( $id, 'medium' );  
 
?></pre>
 
?></pre>
  
=== Link Attachment to Post ===
+
=== 添付ページへのリンク<span id="Link_attachment_to_post"></span> ===
This example will link the attachment to an attachment Page.
+
 
 +
この例は添付ページヘのリンクを表示します。
  
<pre><?php  
+
<pre><?php  
     $id = 9; // ID of an attachment
+
     $id = 9; // 添付の ID
 
     echo wp_get_attachment_link( $id, 'thumbnail', true );  
 
     echo wp_get_attachment_link( $id, 'thumbnail', true );  
 
?></pre>
 
?></pre>
  
=== Link Text to Attachment ===
+
=== テキストによる添付へのリンク<span id="Link_text_to_attachment"></span> ===
  
This example returns an HTML hyperlink with "My link text" linking to an attachment file.
+
この例は添付ファイルヘのリンクを "My link text" という文字列で表示します。
  
<pre><?php  
+
<pre><?php  
     $id = 9; // ID of an attachment
+
     $id = 9; // 添付のID
 
     echo wp_get_attachment_link( $id, '' , false, false, 'My link text' );  
 
     echo wp_get_attachment_link( $id, '' , false, false, 'My link text' );  
 
?></pre>
 
?></pre>
  
=== Link Post Title to Attachment ===
+
=== 投稿タイトルによる添付へのリンク<span id="Link_post_title_to_attachment"></span> ===
  
This example returns an HTML hyperlink with the post title linking to an attachment file.
+
この例は添付ファイルへのリンクを投稿タイトルで表示します。
  
<pre><?php  
+
<pre><?php  
     $id = 9; // ID of an attachment
+
     $id = 9; // 添付のID
 
     echo wp_get_attachment_link( $id, '' );  
 
     echo wp_get_attachment_link( $id, '' );  
?></pre>
+
?></pre>
  
=== Change Icon Directory ===
+
=== アイコンディレクトリを変更する<span id="Change_icon_directory"></span> ===
  
WordPress can use media icons to represent [[Using_Image_and_File_Attachments|attachment files]] on your blog and in the Admin interface, if those icons are available. For images it returns the thumbnail. For other media types It looks for image files named by media type (e.g. audio.jpg) in the directory: ''wp-includes/images/crystal/''.
+
WordPress はブログや管理画面で、メディアアイコンを使って[[Using_Image_and_File_Attachments|添付ファイル]]を表すことができます。画像の場合はサムネイルが表示されますが、その他のメディアタイプはその種類の名前がついたイメージファイル (例: audio.jpg) ''wp-includes/images/crystal/'' ディレクトリから検索します。
  
This example shows how you can change this directory to a folder called "images" in your theme: ''wp-content/themes/yourtheme/images''. Create the folder and put the "media type images" in there. To tell WordPress the directory has changed put this in the current theme's [[Theme_Development#Functions_File|functions.php]] file:
+
この例は、先のディレクトリをどのように "images" フォルダへ変更するのかという手順を説明します。フォルダは ''wp-content/themes/yourtheme/images'' にあるとします。フォルダを作成し、「メディアタイプが画像の添付ファイル」を入れてください。WordPress にディレクトリを変えたことを通知するには、使用中のテーマの [[Theme_Development#Functions_File|functions.php]] ファイルに次のコードを書き込んでください。
  
 
<pre>add_filter( 'icon_dir', 'my_theme_icon_directory' );
 
<pre>add_filter( 'icon_dir', 'my_theme_icon_directory' );
85行目: 90行目:
 
</pre>
 
</pre>
  
== Notes ==
+
== 参考<span id="Notes"></span> ==
  
Use [[Function_Reference/wp_get_attachment_image|wp_get_attachment_image()]] if you want the image only (not a hyperlink).
+
リンクではなく画像だけが欲しい場合は、<tt>[[テンプレートタグ/wp get attachment image|wp_get_attachment_image()]]</tt> を使ってください。
  
== Change Log ==
+
== 変更履歴<span id="Change_Log"></span> ==
Since: 2.5.0
+
  
== Source File ==
+
2.5.0にて導入されました。
  
<tt>wp_get_attachment_link()</tt> is located in {{Trac|wp-includes/post-template.php}}.
+
== ソースファイル<span id="Source_File"></span> ==
 +
 
 +
<tt>wp_get_attachment_link()</tt> {{Trac|wp-includes/post-template.php}} にあります。
 +
 
 +
== 関連項目<span id="Related"></span> ==
  
== Related ==
 
 
{{Attachment Tags}}
 
{{Attachment Tags}}
  
[[Category:Template Tags]]
+
{{原文|Function Reference/wp get attachment link|161771}} <!-- 22:07, 4 November 2017 Tazotodua 版 -->
 +
 
 +
{{DEFAULTSORT:Wp_get_attachment_link}}
 +
[[Category:添付ファイル]]
 +
 
 +
[[en:Function Reference/wp get attachment link]]
 +
[[it:Riferimento funzioni/wp get attachment link]]

2018年7月30日 (月) 19:58時点における最新版

説明

添付ファイルまたはページへの HTML リンクを返します。次のいずれかを含みます。

  1. 添付ファイルが画像のとき、指定されたサイズの画像
  2. 添付ファイルを表すメディアアイコン (指定されたとき)
  3. 添付ファイルのタイトル (テキスト)
  4. 自分で決めたテキスト

指定された添付ファイルが存在しない場合、文字列「添付ファイルが見つかりません (Missing Attachment)」を返します。

使い方

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

デフォルトの使い方

<?php echo wp_get_attachment_link( 13 ); ?>

テンプレート内で添付ファイルの ID を動的に取得するには、get_children() などを使うとよいでしょう。

パラメータ

$id
整数) (オプション) 取得したい添付ファイルの ID。
初期値: ループ内で使った場合、現在の投稿 ID (添付ファイルだけを表示するループである必要があります)。
$size
文字列|配列) (オプション) 画像の大きさ。キーワードとなる文字列(thumbnail, medium, large, full)、または add_image_size() で定義したカスタムサイズのキーワード、もしくは幅と高さをピクセルで指定する要素 2 つの配列、例えば array( 32, 32 )Version 2.5 以降、このパラメータはメディアアイコンの大きさを変えることができず、常に元の大きさで表示されます。
初期値: 'thumbnail'
$permalink
真偽値) (オプション) 添付ファイルや画像への直リンク (デフォルトまたは false)、または添付ページへのリンク (true)。
初期値: 'false'
$icon
真偽値) (オプション) 添付ファイルを表すメディアアイコンを使う (true のとき)。
初期値: 'false'
$text
文字列/真偽値) (オプション) 添付へのテキストリンクを表示する (空ではない文字列を指定したとき)。
初期値: 'false'
$attr
文字列/配列) (オプションwp_get_attachment_image() へ渡す画像属性のリスト。
初期値: 空文字列

用例

例えば次のような形式の文字列を返します。

<a href='http://example.com/wp-content/uploads/2017/11/image-xyz.jpg'><img width="150" height="150" src="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg" class="attachment-thumbnail size-thumbnail" alt="" srcset="http://example.com/wp-content/uploads/2017/11/image-xyz-150x150.jpg 150w, http://example.com/wp-content/uploads/2017/11/image-xyz-50x50.jpg 50w" sizes="(max-width: 150px) 100vw, 150px" /></a>

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

WordPress のデフォルトの画像サイズは "thumbnail" (サムネイル)、"medium" (中)、"large" (大)、"full" (フルサイズ) です。画像サイズは 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 にあるとします。フォルダを作成し、「メディアタイプが画像の添付ファイル」を入れてください。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最新版との差分