gallery_shortcode()


WordPressの関数gallery_shortcode()は、ギャラリーを作成して表示するために使用されます。この関数は、ショートコードを使用して画像ギャラリーを生成する際の動作を定義しています。

構文

gallery_shortcode( array $attr );

引数の説明:

  • $attr (array) — ギャラリーの設定を指定するための引数。

$attrで使用可能な主なキー:

  • ids (string) — ギャラリーに含める画像IDのリスト（カンマ区切り）。
  • columns (int) — ギャラリーの列数を指定します。
  • size (string) — 表示する画像のサイズを指定します（例: 'thumbnail', 'medium'）。
  • link (string) — 画像リンクの動作を指定します（例: 'file', 'none'）。

例1: ギャラリーの基本的な使用法

以下のコードは、投稿内で画像ギャラリーを表示します。

<?php echo gallery_shortcode( array( 'ids' => '1,2,3', 'columns' => 3 ) ); ?>

例2: カスタム関数を使用したギャラリー生成

投稿の添付画像を取得してギャラリーを動的に作成します。

<?php
$post_id = get_the_ID();
$attachments = get_attached_media( 'image', $post_id );
$attachment_ids = wp_list_pluck( $attachments, 'ID' );
echo gallery_shortcode( array( 'ids' => implode( ',', $attachment_ids ), 'size' => 'medium' ) );
?>

例3: 別の列数を指定したギャラリー

列数を4に設定したギャラリーを表示します。

<?php echo gallery_shortcode( array( 'ids' => '4,5,6,7', 'columns' => 4 ) ); ?>

例4: サムネイルサイズの画像を使用

ギャラリーにサムネイルサイズの画像を表示します。

<?php echo gallery_shortcode( array( 'ids' => '8,9,10', 'size' => 'thumbnail' ) ); ?>

例5: リンクなしのギャラリー

画像リンクを無効化したギャラリーを作成します。

<?php echo gallery_shortcode( array( 'ids' => '11,12,13', 'link' => 'none' ) ); ?>

注意事項

  • $attr引数は必須ではありませんが、使用する場合は適切な形式で指定する必要があります。
  • 画像IDが無効または存在しない場合、ギャラリーは正しく表示されません。

関連機能：