• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(和訳完了)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
 +
以下のいずれかを含んだ、添付ファイルまたはページへのHTMLリンクを返す関数です。
  
Returns an HTML hyperlink to an attachment file or page, containing either
+
# 画像添付についてはいくつかの指定されたサイズ
 +
# 添付を意味する指定されたメディアアイコン
 +
# テキスト形式での添付タイトル
 +
# 自分自身で決めたテキスト
  
# An image at some specified size, for image attachments; or
+
そのような添付が存在しない場合、関数は <tt>Missing Attachment</tt> の文字列を返します。
# 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>.
+
<div id="Usage">
 
+
== 使い方 ==
== Usage ==
+
</div>
 
+
<?php wp_get_attachment_link( $id, $size, $permalink, $icon, $text ); ?>
%%%<?php wp_get_attachment_link( $id, $size, $permalink, $icon, $text ); ?>%%%
+
 
+
== Default Usage ==
+
  
 +
<div id="Default_usage">
 +
== デフォルトの使い方 ==
 +
</div>
 
  <?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
 +
テンプレートの中に添付IDをダイナミックに取得する場合は、 <tt>[[関数リファレンス/get_children|get_children()]]</tt> などを用いるとよいでしょう。
  
== Parameters ==
+
<div id="Parameters">
{{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'}}
+
</div>
{{Parameter|$permalink|boolean|Link directly to the attachment file/image (<tt>Default</tt>), or to the attachment page. |Optional|'False'}}
+
{{Parameter|$id|整数| 所望する添付のID。|Optional|[[ループ]] で使われる場合は、現状の投稿ID。(添付だけを表示するループである必要があります。)}}
 +
{{Parameter|$size|文字列または配列|画像のサイズ。いづれかのキーワードとなる文字列 (thumbnail, medium, large, full)、または幅と高さをピクセルで表す配列で(例<tt>array(32,32)</tt>)表します。[[Version 2.5]]以降、このパラメーターはメディアアイコンの大きさを変えることができなくなりました。これは常に元の大きさで表示されるためです。|Optional|'thumbnail'}}
 +
{{Parameter|$permalink|boolean|添付ファイルまたは画像への直リンク(<tt>Default</tt>)、または添付ページへのリンク。|Optional|'False'}}
 
:* <tt>1 (True)</tt>  
 
:* <tt>1 (True)</tt>  
:* <tt>0 (False)</tt> - Default
+
:* <tt>0 (False)</tt> - デフォルト
{{Parameter|$icon|boolean|Use a media icon to represent the attachment.|Optional|'False'}}
+
{{Parameter|$icon|boolean|添付を表すメディアアイコンを使用する。|Optional|'False'}}
 
:* <tt>1 (True)</tt>  
 
:* <tt>1 (True)</tt>  
:* <tt>0 (False)</tt> - Default
+
:* <tt>0 (False)</tt> - デフォルト
{{Parameter|$text|string|Displays a text link to the attachment.|Optional|'false'}}
+
{{Parameter|$text|文字列|添付へのテキストリンクを表示させる。|Optional|'false'}}
==Examples==
+
  
=== Show Medium Size Attachment. ===
+
<div id="Examples">
 
+
== 用例 ==
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.
+
</div>
 +
<div id="Show_medium_size_attachment">
 +
=== 中サイズの添付へのリンク ===
 +
</div>
 +
WordPressであなたがアップロードした画像のデフォルトサイズは、"サムネイル""""""フルサイズ"があります。画像サイズはWordPress管理画面の設定→[[Settings Media SubPanel|メディア設定]]から変更可能です。
  
 
  <pre><?php  
 
  <pre><?php  
     $id = 9; // ID of an attachment
+
     $id = 9; // 添付のID
 
     echo wp_get_attachment_link( $id, 'medium' );  
 
     echo wp_get_attachment_link( $id, 'medium' );  
 
?></pre>
 
?></pre>
  
=== Link Attachment to Post ===
+
<div id="Link_attachment_to_post">
This example will link the attachment to an attachment Page.
+
=== 添付へのリンク ===
 +
</div>
 +
この例では、添付ページヘのリンクを表示します。
  
 
  <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 ===
+
<div id="Link_text_to_attachment">
 
+
=== 添付へのテキストリンク ===
This example returns an HTML hyperlink with "My link text" linking to an attachment file.
+
</div>
 +
この例では、添付ページヘ"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 ===
+
<div id="Link_post_title_to_attachment">
 
+
=== 添付への投稿タイトルリンク ===
This example returns an HTML hyperlink with the post title linking to an attachment file.
+
</div>
 +
この例では、添付ファイルへの投稿タイトルのリンクを表示します。
  
 
  <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 ===
+
<div id="Change_icon_directory">
 +
=== アイコンディレクトリを変更する ===
 +
</div>
 +
WordPressはブログや管理インターフェイス上で、メディアアイコンを使って[[Using_Image_and_File_Attachments|添付ファイル]]を表すことができます。画像の場合はサムネイルが表示されますが、その他のメディアタイプはその種類の名前がついたイメージファイル (例: audio.jpg) を ''wp-includes/images/crystal/'' ディレクトリから検索します。
  
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/''.
+
この例は、先のディレクトリをどのように"images"フォルダーへ変更するのかという手順を、''wp-content/themes/yourtheme/images''というテーマを例に説明しています。フォルダを作成し、 "media type images" を記載してください。WordPressにディレクトリが変更したことを通知するためには、使用中であるテーマの [[Theme_Development#Functions_File|functions.php]] ファイルにこれを書き込んでください。
 
+
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:
+
  
 
<pre>add_filter( 'icon_dir', 'my_theme_icon_directory' );
 
<pre>add_filter( 'icon_dir', 'my_theme_icon_directory' );
85行目: 99行目:
 
</pre>
 
</pre>
  
== Notes ==
+
<div id="Notes">
 
+
== 注釈 ==
Use [[Function_Reference/wp_get_attachment_image|wp_get_attachment_image()]] if you want the image only (not a hyperlink).
+
</div>
 
+
リンクではなく画像だけが欲しい場合は、 [[Function_Reference/wp_get_attachment_image|wp_get_attachment_image()]] を用いてください。
== Change Log ==
+
Since: 2.5.0
+
  
== Source File ==
+
<div id="Change_log">
 +
== 変更履歴 ==
 +
</div>
 +
2.5.0にて導入されました。
  
<tt>wp_get_attachment_link()</tt> is located in {{Trac|wp-includes/post-template.php}}.
+
<div id="Source_file">
 +
== ソースファイル ==
 +
</div>
 +
<tt>wp_get_attachment_link()</tt> {{Trac|wp-includes/post-template.php}} にあります。
  
== Related ==
+
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 
{{Attachment Tags}}
 
{{Attachment Tags}}
 +
{{原文|Function Reference/wp get attachment link|108695}}<!-- 01:15, 21 August 2011 Jayjdk -->
  
 
[[Category:Template Tags]]
 
[[Category:Template Tags]]

2013年6月23日 (日) 08:14時点における版

以下のいずれかを含んだ、添付ファイルまたはページへの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最新版との差分