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

「ギャラリーショートコードの使い方」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(2.9: include, exclude オプション追加 /link オプション追加(バージョン不明)、未翻訳)
(残りを和訳。)
 
(3人の利用者による、間の5版が非表示)
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
In [[Version 2.5|WordPress 2.5]], the [[用語集#Gallery|Gallery]] feature allows the option to add an image gallery to a Post or [[Pages|Page]] on your WordPress blog.
+
[[用語集#Gallery|ギャラリー]]機能により投稿や固定ページへ画像ギャラリーを追加できます。
  
The <code>[gallery]</code> [[ショートコード API|shortcode]] is used in a Post or Page to display a thumbnail gallery of images attached to that post.  It can be used in its simplest form like this:
+
WordPress [[Version 2.5|バージョン 2.5]]から[[Version 3.5|3.5]]まで、ギャラリーショートコードは一般的に以下の基本的な形態で使用しました。これは投稿に添付された画像のサムネイルギャラリーを表示していました:
  
 
  [gallery]
 
  [gallery]
  
There are several options that may be specified using this syntax:
+
[[Version 3.5|WordPress 3.5]]以降では、ギャラリーショートコードは以下のようにデフォルトで画像 ID を含めます:
 +
 
 +
[gallery ids="729,732,731,720"]
 +
 
 +
この形式のギャラリーショートコードは 3.5 の新機能というわけではありません。以前は <code>include</code> 属性を使って同様に指定できました。しかし''今の形式''のほうが、バージョン3.5で導入された [[Inserting_Images_into_Posts_and_Pages|メディアワークフロー]] /[[:en:Inserting_Images_into_Posts_and_Pages|en]] で簡単に作ったり編集したりできます。
 +
 
 +
ショートコード内に ID を指定することにより、投稿に「添付」されていない(投稿や固定ページの編集画面でアップロードしていない)画像もギャラリーへ入れることができます。この柔軟性があるので、'''任意の枚数の画像'''を含んだ'''任意の個数のギャラリー'''を作って埋め込むことができます !
 +
 
 +
'''参考:''' ギャラリーショートコードの「基本形」である <code>[gallery]</code> を投稿や固定ページで使うと、その投稿や固定ページへ「添付されている」画像だけが表示されます。
 +
 
 +
<div id="Usage">
 +
==使い方 ==
 +
</div>
 +
 
 +
以下の書き方でいくつかオプションを指定することができます。
  
 
  [gallery option1="value1" option2="value2"]
 
  [gallery option1="value1" option2="value2"]
  
You can also print a gallery directly in a template like so:
+
テンプレートファイル内で直接ギャラリーを出力することもできます。
  
   <?php echo do_shortcode('[gallery option1="value1"]'); ?>
+
   <?php echo do_shortcode( '[gallery option1="value1"]' ); ?>
  
This works too:
+
以下のように記述しても大丈夫です。
  
 
   <?php
 
   <?php
22行目: 36行目:
 
   ?>
 
   ?>
  
== Options ==
+
<div id="Options">
 +
== オプション ==
 +
</div>
  
The following basic options are supported:
+
以下の基本的なオプションをサポートしています:
  
; columns : specify the number of columns.  The gallery will include a break tag at the end of each row, and calculate the column width as appropriate.  The default value is 3.  If columns is set to 0, no row breaks will be included.  For example, to display a 4 column gallery:
+
; orderby : 画像の表示順序のキーとなる項目を指定します。スペース区切りで複数指定できます。初期値は "menu_order ID" です。"RAND"(ランダム)も指定できますがその場合、order の指定は無視されます。
 +
:* menu_order - '''メディアを挿入'''ポップアップの'''ギャラリー'''タブ内で画像を手動で並べ替える
 +
:* title - '''メディアライブラリ'''内の画像タイトルの順
 +
:* post_date - 日付/時刻でソート
 +
:* rand - ランダムな順
 +
:* ID
 +
 
 +
; order : 画像の表示順序を ASC(昇順)または DESC(降順)で指定します。初期値は "ASC" です。例えば ID の降順にソートするには:
 +
 
 +
  [gallery order="DESC" orderby="ID"]
 +
 
 +
; columns : カラム数を指定します。それぞれの行の後には改行タグが挿入され、カラムの幅は適切に調整されます。初期値は3です。0にすると改行タグは挿入されません。例えば、4カラムのギャラリーなら以下のように指定します。
  
 
  [gallery columns="4"]
 
  [gallery columns="4"]
  
; id : specify the post ID.  The gallery will display images which are attached to that post.  The default behaviour if no ID is specified is to display images attached to the current post.  For example, to display images attached to post 123:
+
; id : 投稿 ID を指定します。指定された投稿に添付されている画像のギャラリーを表示します。ID の指定がない場合は、現在の投稿がギャラリーの対象になります。例えば、ID が123の投稿に添付された画像のギャラリーを表示するなら以下のように指定します。
  
 
  [gallery id="123"]
 
  [gallery id="123"]
  
; size : specify the image size to use for the thumbnail display.  Valid values include "thumbnail", "medium", "large" and "full".  The default is "thumbnail". The size of the images for "thumbnail", "medium" and "large" can be configured in WordPress admin panel under Settings > Media. For example, to display a gallery of medium sized images:
+
<div class="information">'''注意''': id と ids は異なるオプションです。ids は include と同様に画像の ID を指定します(2つ以上はコンマで区切ります)。</div>
 +
 
 +
; size : ギャラリーとして表示するサムネイル画像のサイズを指定します。指定できる値は "thumbnail", "medium", "large", "full" および [[関数リファレンス/add_image_size | add_image_size()]] で登録した追加の画像サイズです。初期値は "thumbnail" です。"thumbnail(サムネイルのサイズ)", "medium(中サイズ)", "large(大サイズ)" の画像サイズは管理画面の 設定 > メディア で指定できます。例えば、"medium(中サイズ)" の画像ギャラリーを表示するなら以下のように指定します。
  
 
  [gallery size="medium"]
 
  [gallery size="medium"]
  
Some advanced options are available:
 
  
; orderby : specify the sort order used to display thumbnails.  The default is "menu_order ASC, ID ASC". "RAND" (random) is also supported.
+
さらに高度な設定をすることもできます。
  
; itemtag : the name of the XHTML tag used to enclose each item in the gallery.  The default is "dl".
+
; itemtag : ギャラリーの各項目(画像とキャプション)を囲む XHTML タグの名前を指定します。初期値は "dl" です。
  
; icontag : the name of the XHTML tag used to enclose each thumbnail icon in the gallery.  The default is "dt".
+
; icontag : ギャラリーの各画像を囲む XHTML タグを指定します。初期値は "dt" です。
  
; captiontag: the name of the XHTML tag used to enclose each caption.  The default is "dd".  For example, to change the gallery markup to use div, span and p tags:
+
; captiontag: 各キャプションを囲む XHTML タグを指定します。初期値は "dd" です。例えば、ギャラリーのマークアップを div, span, p タグに変更するなら以下のように指定します。
  
; link: you can set it to "file" so each image will link to the image file. The default value links to the attachment's permalink.
+
[gallery itemtag="div" icontag="span" captiontag="p"]
  
; include: comma separated attachment IDs, [gallery include="23,39,45"] will show only the images from these attachments.
+
; link: "file" を指定すると各画像は画像ファイルへリンクされます。初期値は添付ファイルのページのパーマリンクです。
 +
:* file - 画像ファイルに直接リンク
 +
:* none - リンクなし
  
; exclude: comma separated attachment IDs, [gallery exclude="21,32,43"] excludes the images from these attachments. Please note that '''include''' and '''exclude''' cannot be used together.
+
[gallery link="file"]
  
  [gallery itemtag="div" icontag="span" captiontag="p" link="file"]
+
; include: 表示したい添付画像の ID をコンマで区切って指定します。以下のように指定すると、指定した ID の画像のみ表示されます。
 +
 
 +
  [gallery include="23,39,45"]
 +
 
 +
; exclude: 表示したくない添付画像の ID をコンマで区切って指定します。include と exclude は同時に指定しないでください。同時に指定した場合は include が優先されます。
 +
 
 +
[gallery exclude="21,32,43"]
 +
 
 +
<div id="Developers_-_Things_to_consider">
 +
== 開発者向け - 考慮すべきこと ==
 +
</div>
 +
 
 +
ID を明示しないギャラリーのデフォルトの期待される動作は、現在の投稿を親の投稿とするすべての画像を追加します。つまり、現在の投稿の編集画面で「メディアを追加」ボタン/リンクを使ってアップロードしたすべての画像を追加します。これには後から投稿へ追加したすべての添付ファイルも含まれることを覚えておきましょう。それが添付ファイルとして表示されていたかどうかは関係ありません。
 +
 
 +
引数を与えない場合のデフォルトの動作(フォールバック)は以下のとおりです: <tt>...lorem [gallery] ipsum...</tt>
 +
 
 +
<pre>
 +
$attachments = get_children( array(
 +
'post_parent'    => $attr['id'],
 +
'post_status'    => 'inherit',
 +
'post_type'      => 'attachment',
 +
'post_mime_type' => 'image',
 +
'order'          => $attr['order'],
 +
'orderby'        => $attr['orderby'],
 +
) );
 +
</pre>
 +
 
 +
さらに <tt>shortcode_atts()</tt>(および他の処理)で <tt>extract()</tt> を使うのは止めましょう。IDE(訳注:統合開発環境)はそれをバックトレース'''できません'''。
  
 
== 変更履歴 ==
 
== 変更履歴 ==
61行目: 118行目:
 
* [[Version 2.5|2.5]] : 新規機能
 
* [[Version 2.5|2.5]] : 新規機能
  
{{原文|Gallery Shortcode|81322}}<!-- 12:03, 23 December 2009 Azaozz 版 -->
+
== ソースファイル ==
 +
 
 +
ギャラリーショートコードは {{Trac|wp-includes/media.php}} にあります。
 +
 
 +
== 関連項目 ==
 +
 
 +
{{Shortcodes}}
 +
 
 +
{{原文|Gallery Shortcode|150752}} <!-- 10:56, 10 April 2015 Ramiy 版 -->
  
 
{{DEFAULTSORT:きやらりいしよおとこおとのつかいかた}}
 
{{DEFAULTSORT:きやらりいしよおとこおとのつかいかた}}
 
[[Category:上級トピック]]
 
[[Category:上級トピック]]
 +
[[Category:ショートコード]]
 
[[Category:WordPress の開発]]
 
[[Category:WordPress の開発]]
 
[[Category:wp2.5]]
 
[[Category:wp2.5]]
 
[[Category:wp2.9]]
 
[[Category:wp2.9]]
  
[[en:Using the gallery shortcode]]
+
[[en:Gallery Shortcode]]
 +
[[it:Shortcode Gallery]]
 +
[[pt-br:Shortcode Gallery]]
 +
[[ru:Короткий код для галерей]]

2016年4月21日 (木) 00:34時点における最新版

この項目「ギャラリーショートコードの使い方」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

ギャラリー機能により投稿や固定ページへ画像ギャラリーを追加できます。

WordPress バージョン 2.5から3.5まで、ギャラリーショートコードは一般的に以下の基本的な形態で使用しました。これは投稿に添付された画像のサムネイルギャラリーを表示していました:

[gallery]

WordPress 3.5以降では、ギャラリーショートコードは以下のようにデフォルトで画像 ID を含めます:

[gallery ids="729,732,731,720"]

この形式のギャラリーショートコードは 3.5 の新機能というわけではありません。以前は include 属性を使って同様に指定できました。しかし今の形式のほうが、バージョン3.5で導入された メディアワークフロー /en で簡単に作ったり編集したりできます。

ショートコード内に ID を指定することにより、投稿に「添付」されていない(投稿や固定ページの編集画面でアップロードしていない)画像もギャラリーへ入れることができます。この柔軟性があるので、任意の枚数の画像を含んだ任意の個数のギャラリーを作って埋め込むことができます !

参考: ギャラリーショートコードの「基本形」である [gallery] を投稿や固定ページで使うと、その投稿や固定ページへ「添付されている」画像だけが表示されます。

以下の書き方でいくつかオプションを指定することができます。

[gallery option1="value1" option2="value2"]

テンプレートファイル内で直接ギャラリーを出力することもできます。

 <?php echo do_shortcode( '[gallery option1="value1"]' ); ?>

以下のように記述しても大丈夫です。

 <?php
    $gallery_shortcode = '[gallery id="' . intval( $post->post_parent ) . '"]';
    print apply_filters( 'the_content', $gallery_shortcode );
 ?>

オプション

以下の基本的なオプションをサポートしています:

orderby 
画像の表示順序のキーとなる項目を指定します。スペース区切りで複数指定できます。初期値は "menu_order ID" です。"RAND"(ランダム)も指定できますがその場合、order の指定は無視されます。
  • menu_order - メディアを挿入ポップアップのギャラリータブ内で画像を手動で並べ替える
  • title - メディアライブラリ内の画像タイトルの順
  • post_date - 日付/時刻でソート
  • rand - ランダムな順
  • ID
order 
画像の表示順序を ASC(昇順)または DESC(降順)で指定します。初期値は "ASC" です。例えば ID の降順にソートするには:
 [gallery order="DESC" orderby="ID"]
columns 
カラム数を指定します。それぞれの行の後には改行タグが挿入され、カラムの幅は適切に調整されます。初期値は3です。0にすると改行タグは挿入されません。例えば、4カラムのギャラリーなら以下のように指定します。
[gallery columns="4"]
id 
投稿 ID を指定します。指定された投稿に添付されている画像のギャラリーを表示します。ID の指定がない場合は、現在の投稿がギャラリーの対象になります。例えば、ID が123の投稿に添付された画像のギャラリーを表示するなら以下のように指定します。
[gallery id="123"]
注意: id と ids は異なるオプションです。ids は include と同様に画像の ID を指定します(2つ以上はコンマで区切ります)。
size 
ギャラリーとして表示するサムネイル画像のサイズを指定します。指定できる値は "thumbnail", "medium", "large", "full" および add_image_size() で登録した追加の画像サイズです。初期値は "thumbnail" です。"thumbnail(サムネイルのサイズ)", "medium(中サイズ)", "large(大サイズ)" の画像サイズは管理画面の 設定 > メディア で指定できます。例えば、"medium(中サイズ)" の画像ギャラリーを表示するなら以下のように指定します。
[gallery size="medium"]


さらに高度な設定をすることもできます。

itemtag 
ギャラリーの各項目(画像とキャプション)を囲む XHTML タグの名前を指定します。初期値は "dl" です。
icontag 
ギャラリーの各画像を囲む XHTML タグを指定します。初期値は "dt" です。
captiontag
各キャプションを囲む XHTML タグを指定します。初期値は "dd" です。例えば、ギャラリーのマークアップを div, span, p タグに変更するなら以下のように指定します。
[gallery itemtag="div" icontag="span" captiontag="p"]
link
"file" を指定すると各画像は画像ファイルへリンクされます。初期値は添付ファイルのページのパーマリンクです。
  • file - 画像ファイルに直接リンク
  • none - リンクなし
[gallery link="file"]
include
表示したい添付画像の ID をコンマで区切って指定します。以下のように指定すると、指定した ID の画像のみ表示されます。
[gallery include="23,39,45"] 
exclude
表示したくない添付画像の ID をコンマで区切って指定します。include と exclude は同時に指定しないでください。同時に指定した場合は include が優先されます。
[gallery exclude="21,32,43"] 

開発者向け - 考慮すべきこと

ID を明示しないギャラリーのデフォルトの期待される動作は、現在の投稿を親の投稿とするすべての画像を追加します。つまり、現在の投稿の編集画面で「メディアを追加」ボタン/リンクを使ってアップロードしたすべての画像を追加します。これには後から投稿へ追加したすべての添付ファイルも含まれることを覚えておきましょう。それが添付ファイルとして表示されていたかどうかは関係ありません。

引数を与えない場合のデフォルトの動作(フォールバック)は以下のとおりです: ...lorem [gallery] ipsum...

$attachments = get_children( array(
	'post_parent'    => $attr['id'],
	'post_status'    => 'inherit',
	'post_type'      => 'attachment',
	'post_mime_type' => 'image',
	'order'          => $attr['order'],
	'orderby'        => $attr['orderby'],
) );

さらに shortcode_atts()(および他の処理)で extract() を使うのは止めましょう。IDE(訳注:統合開発環境)はそれをバックトレースできません

変更履歴

  • 2.9 : include, exclude オプション追加
  • 2.5 : 新規機能

ソースファイル

ギャラリーショートコードは wp-includes/media.php にあります。

関連項目

ショートコード: [audio] /en, [caption] /en, [embed] /en, [gallery] /en, [playlist] /en, [video] /en

最新英語版: WordPress Codex » Gallery Shortcode最新版との差分