- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「テンプレートタグ/the attachment link」の版間の差分
提供: WordPress Codex 日本語版
< テンプレートタグ
(英語版をコピペ) |
(和訳完了。) |
||
1行目: | 1行目: | ||
− | = | + | <div id="Description"> |
− | + | == 説明 == | |
− | + | </div> | |
− | + | 以下のいずれかを含んだ、[[Using_Image_and_File_Attachments|添付]] ファイルまたはページへのHTMLリンクを返す関数です。 | |
− | + | # 画像の場合、フルサイズ画像またはサムネイル。 | |
+ | # 画像以外の場合は、テキストで添付のタイトル。 | ||
− | + | そのような添付が存在しない場合、関数は <tt>Missing Attachment</tt> の文字列を返します。 | |
− | + | <div id="Usage"> | |
+ | == 使い方 == | ||
+ | </div> | ||
+ | <?php the_attachment_link( $id, $fullsize, $deprecated, $permalink ); ?> | ||
− | == | + | <div id="Default_usage"> |
− | + | == デフォルトの使い方 == | |
+ | </div> | ||
<?php the_attachment_link( 7 ); ?> | <?php the_attachment_link( 7 ); ?> | ||
− | = | + | <div id="Parameters"> |
− | + | == パラメータ == | |
− | {{Parameter|$id| | + | </div> |
− | {{Parameter|fullsize|boolean| | + | {{Parameter|$id|整数|所望する添付のID。|Optional|[[ループ]] で使われる場合は、現状の投稿ID。(添付だけを表示するループである必要があります)}} |
+ | {{Parameter|fullsize|boolean|画像の場合、オリジナルの画像 (<var>true</var>) またはWordPressが生成したサムネイル (<var>false</var>)。もし <var>false</var> にセットされながらもサムネイルが見つからなかった場合は、フルサイズの画像が代わりに用いられます。|Optional|'False'}} | ||
:* <tt>1 (True)</tt> | :* <tt>1 (True)</tt> | ||
− | :* <tt>0 (False)</tt> - | + | :* <tt>0 (False)</tt> - デフォルト |
− | {{Parameter|$max_dims| | + | {{Parameter|$max_dims|配列|イメージもしくはアイコンの縦横最大値。関数によって出力されたイメージエレメント (<tt>img</tt>) の <var>width</var> と <var>height</var> に適用されます。アスペクト比は保たれます。|[[Version 2.3]]にて廃止されました。|not used}} |
− | {{Parameter|$permalink|boolean| | + | {{Parameter|$permalink|boolean|添付ファイルもしくは画像への直リンク (<tt>Default</tt>)、または添付ページヘのリンク。|Optional|'False'}} |
:* <tt>1 (True)</tt> | :* <tt>1 (True)</tt> | ||
− | :* <tt>0 (False)</tt> - | + | :* <tt>0 (False)</tt> - デフォルト |
− | = | + | <div id="Examples"> |
+ | == 用例 == | ||
+ | </div> | ||
<pre><?php | <pre><?php | ||
− | // | + | // フルサイズ画像への直リンクを表す。 |
the_attachment_link( 4, true ); | the_attachment_link( 4, true ); | ||
− | // | + | // 添付ページヘのサムネイルリンクを表す。 |
the_attachment_link( 4, false, false, true ); | the_attachment_link( 4, false, false, true ); | ||
?></pre> | ?></pre> | ||
− | = | + | <div id="Notes"> |
− | + | == 注釈 == | |
− | + | </div> | |
− | + | 画像ではなくリンクだけが欲しい場合は、 [[Function Reference/wp_get_attachment_link|wp_get_attachment_link()]] を用いてください。 | |
− | + | ||
− | + | ||
− | == | + | <div id="Change_log"> |
+ | == 変更履歴 == | ||
+ | </div> | ||
+ | 2.0.0にて導入されました。 | ||
− | <tt>the_attachment_link()</tt> | + | <div id="Source_file"> |
+ | == ソースファイル == | ||
+ | </div> | ||
+ | <tt>the_attachment_link()</tt> は {{Trac|wp-includes/post-template.php}} にあります。 | ||
− | = | + | <div id="Related"> |
+ | == 関連資料 == | ||
+ | </div> | ||
{{Attachment Tags}} | {{Attachment Tags}} | ||
+ | {{原文|Function Reference/the attachment link|123380}}<!-- 13:57, 25 November 2012 M0r7if3r --> | ||
[[Category:Attachments]] | [[Category:Attachments]] | ||
[[Category:Template_Tags]] | [[Category:Template_Tags]] |
2013年6月30日 (日) 07:00時点における版
以下のいずれかを含んだ、添付 ファイルまたはページへのHTMLリンクを返す関数です。
- 画像の場合、フルサイズ画像またはサムネイル。
- 画像以外の場合は、テキストで添付のタイトル。
そのような添付が存在しない場合、関数は Missing Attachment の文字列を返します。
使い方
<?php the_attachment_link( $id, $fullsize, $deprecated, $permalink ); ?>
デフォルトの使い方
<?php the_attachment_link( 7 ); ?>
パラメータ
- $id
- (整数) (Optional) 所望する添付のID。
- 初期値: ループ で使われる場合は、現状の投稿ID。(添付だけを表示するループである必要があります)
- fullsize
- (boolean) (Optional) 画像の場合、オリジナルの画像 (true) またはWordPressが生成したサムネイル (false)。もし false にセットされながらもサムネイルが見つからなかった場合は、フルサイズの画像が代わりに用いられます。
- 初期値: 'False'
- 1 (True)
- 0 (False) - デフォルト
- $max_dims
- (配列) (Version 2.3にて廃止されました。) イメージもしくはアイコンの縦横最大値。関数によって出力されたイメージエレメント (img) の width と height に適用されます。アスペクト比は保たれます。
- 初期値: not used
- $permalink
- (boolean) (Optional) 添付ファイルもしくは画像への直リンク (Default)、または添付ページヘのリンク。
- 初期値: 'False'
- 1 (True)
- 0 (False) - デフォルト
用例
<?php // フルサイズ画像への直リンクを表す。 the_attachment_link( 4, true ); // 添付ページヘのサムネイルリンクを表す。 the_attachment_link( 4, false, false, true ); ?>
注釈
画像ではなくリンクだけが欲しい場合は、 wp_get_attachment_link() を用いてください。
変更履歴
2.0.0にて導入されました。
ソースファイル
the_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/the attachment link (最新版との差分)