【WordPress】ギャラリーウィジェットの使い方とカスタマイズ方法【コードあり】

2021/03/03 2023/03/19

WordPressでは、複数の画像をまとめて表示できるギャラリーウィジェットを使うことができます。

本記事では、ギャラリーウィジェットの使い方とカスタマイズ方法について解説していきます。

実際にギャラリーウィジェットを設置すると、↓みたいな感じになります。右側の「GALLERY」ってやつです。
画像が5枚表示されているのがわかると思います。
ちなみに・・・表示する画像の枚数や大きさ、リンクの有り無しなど、いろいろ細かい設定もできるので、そちらも紹介します👍 pic.twitter.com/JhaPgtMFP6

— マルユメ@WordPressテーマ開発してブログ運営 (@maruyumeblog) July 13, 2022

サイトにギャラリーを設置したいけど、やり方がわからない・・・

ギャラリーウィジェットをカスタマイズしたいけど、やり方がわからない

という方は、本記事が参考になるはずです。

Contents

【WordPress】ギャラリーウィジェットの使い方とカスタマイズ方法【コードあり】
- ギャラリーウィジェットの使い方
- ギャラリーウィジェットをカスタマイズする

【WordPress】ギャラリーウィジェットの使い方とカスタマイズ方法【コードあり】

ギャラリーウィジェットの使い方

まずは、ギャラリーウィジェットの使い方です。

具体的な手順は、以下の通り。

ウィジェットを設置する
画像を追加する
ギャラリーを作成する
ギャラリーを挿入する

順番に解説していきます。

ウィジェットを設置する

まずは、WordPressの管理画面にログインして「外観 → ウィジェット」に移動します。

ギャラリーウィジェットを選択して、表示したいウィジェットエリアに設置します。

画像を追加する

「画像を追加」でギャラリーウィジェットに表示する画像を選択します。1枚だけ表示することもできますし、複数の画像を表示することもできます。

ギャラリーを作成する

画像を選択したら「ギャラリーを作成」をクリックし、右側にある「ギャラリーの設定」を確認します。

ギャラリーの設定では、

リンク先 → 画像をクリックしたときのリンク先
カラム → 画像を横にいくつ並べるか
ランダム → 画像の並びをランダム表示にするか
サイズ → 画像のサイズ

をそれぞれ変更できます。

ギャラリーを挿入する

最後に「ギャラリーを挿入」をクリックして「保存」すれば、実際に作ったギャラリーがサイト上に表示されます。

上記の例では、

リンク先 → 添付ファイルのページ
カラム → 3
ランダム表示 → なし
サイズ → サムネイル

の設定で作成しています。

ギャラリーの設定は後から変更できる

ギャラリーの設定は、ギャラリーを作成した後でも変更できます。

「ギャラリーを編集」をクリックすればギャラリーの設定画面が開きます。

編集したら「ギャラリーの更新」 → 「保存」でギャラリーが更新されます。

ギャラリーウィジェットをカスタマイズする

ギャラリーウィジェットのソースコードは、下記のディレクトリに入っています。

ドメイン/wp-includes/widgets/class-wp-widget-media-gallery.php

このclass-wp-widget-media-gallery.phpを編集することで、カスタマイズが可能になります。

class-wp-widget-media-gallery.phpの全コードは、下記のとおり。

<?php
/**
 * Widget API: WP_Widget_Media_Gallery class
 *
 * @package WordPress
 * @subpackage Widgets
 * @since 4.9.0
 */

/**
 * Core class that implements a gallery widget.
 *
 * @since 4.9.0
 *
 * @see WP_Widget_Media
 * @see WP_Widget
 */
class WP_Widget_Media_Gallery extends WP_Widget_Media {

	/**
	 * Constructor.
	 *
	 * @since 4.9.0
	 */
	public function __construct() {
		parent::__construct(
			'media_gallery',
			__( 'Gallery' ),
			array(
				'description' => __( 'Displays an image gallery.' ),
				'mime_type'   => 'image',
			)
		);

		$this->l10n = array_merge(
			$this->l10n,
			array(
				'no_media_selected' => __( 'No images selected' ),
				'add_media'         => _x( 'Add Images', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),
				'replace_media'     => '',
				'edit_media'        => _x( 'Edit Gallery', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),
			)
		);
	}

	/**
	 * Get schema for properties of a widget instance (item).
	 *
	 * @since 4.9.0
	 *
	 * @see WP_REST_Controller::get_item_schema()
	 * @see WP_REST_Controller::get_additional_fields()
	 * @link https://core.trac.wordpress.org/ticket/35574
	 *
	 * @return array Schema for properties.
	 */
	public function get_instance_schema() {
		$schema = array(
			'title'          => array(
				'type'                  => 'string',
				'default'               => '',
				'sanitize_callback'     => 'sanitize_text_field',
				'description'           => __( 'Title for the widget' ),
				'should_preview_update' => false,
			),
			'ids'            => array(
				'type'              => 'array',
				'items'             => array(
					'type' => 'integer',
				),
				'default'           => array(),
				'sanitize_callback' => 'wp_parse_id_list',
			),
			'columns'        => array(
				'type'    => 'integer',
				'default' => 3,
				'minimum' => 1,
				'maximum' => 9,
			),
			'size'           => array(
				'type'    => 'string',
				'enum'    => array_merge( get_intermediate_image_sizes(), array( 'full', 'custom' ) ),
				'default' => 'thumbnail',
			),
			'link_type'      => array(
				'type'                  => 'string',
				'enum'                  => array( 'post', 'file', 'none' ),
				'default'               => 'post',
				'media_prop'            => 'link',
				'should_preview_update' => false,
			),
			'orderby_random' => array(
				'type'                  => 'boolean',
				'default'               => false,
				'media_prop'            => '_orderbyRandom',
				'should_preview_update' => false,
			),
		);

		/** This filter is documented in wp-includes/widgets/class-wp-widget-media.php */
		$schema = apply_filters( "widget_{$this->id_base}_instance_schema", $schema, $this );

		return $schema;
	}

	/**
	 * Render the media on the frontend.
	 *
	 * @since 4.9.0
	 *
	 * @param array $instance Widget instance props.
	 */
	public function render_media( $instance ) {
		$instance = array_merge( wp_list_pluck( $this->get_instance_schema(), 'default' ), $instance );

		$shortcode_atts = array_merge(
			$instance,
			array(
				'link' => $instance['link_type'],
			)
		);

		// @codeCoverageIgnoreStart
		if ( $instance['orderby_random'] ) {
			$shortcode_atts['orderby'] = 'rand';
		}

		// @codeCoverageIgnoreEnd
		echo gallery_shortcode( $shortcode_atts );
	}

	/**
	 * Loads the required media files for the media manager and scripts for media widgets.
	 *
	 * @since 4.9.0
	 */
	public function enqueue_admin_scripts() {
		parent::enqueue_admin_scripts();

		$handle = 'media-gallery-widget';
		wp_enqueue_script( $handle );

		$exported_schema = array();
		foreach ( $this->get_instance_schema() as $field => $field_schema ) {
			$exported_schema[ $field ] = wp_array_slice_assoc( $field_schema, array( 'type', 'default', 'enum', 'minimum', 'format', 'media_prop', 'should_preview_update', 'items' ) );
		}
		wp_add_inline_script(
			$handle,
			sprintf(
				'wp.mediaWidgets.modelConstructors[ %s ].prototype.schema = %s;',
				wp_json_encode( $this->id_base ),
				wp_json_encode( $exported_schema )
			)
		);

		wp_add_inline_script(
			$handle,
			sprintf(
				'
					wp.mediaWidgets.controlConstructors[ %1$s ].prototype.mime_type = %2$s;
					_.extend( wp.mediaWidgets.controlConstructors[ %1$s ].prototype.l10n, %3$s );
				',
				wp_json_encode( $this->id_base ),
				wp_json_encode( $this->widget_options['mime_type'] ),
				wp_json_encode( $this->l10n )
			)
		);
	}

	/**
	 * Render form template scripts.
	 *
	 * @since 4.9.0
	 */
	public function render_control_template_scripts() {
		parent::render_control_template_scripts();
		?>
		<script type="text/html" id="tmpl-wp-media-widget-gallery-preview">
			<#
			var ids = _.filter( data.ids, function( id ) {
				return ( id in data.attachments );
			} );
			#>
			<# if ( ids.length ) { #>
				<ul class="gallery media-widget-gallery-preview" role="list">
					<# _.each( ids, function( id, index ) { #>
						<# var attachment = data.attachments[ id ]; #>
						<# if ( index < 6 ) { #>
							<li class="gallery-item">
								<div class="gallery-icon">
									<img alt="{{ attachment.alt }}"
										<# if ( index === 5 && data.ids.length > 6 ) { #> aria-hidden="true" <# } #>
										<# if ( attachment.sizes.thumbnail ) { #>
											src="{{ attachment.sizes.thumbnail.url }}" width="{{ attachment.sizes.thumbnail.width }}" height="{{ attachment.sizes.thumbnail.height }}"
										<# } else { #>
											src="{{ attachment.url }}"
										<# } #>
										<# if ( ! attachment.alt && attachment.filename ) { #>
											aria-label="
											<?php
											echo esc_attr(
												sprintf(
													/* translators: %s: The image file name. */
													__( 'The current image has no alternative text. The file name is: %s' ),
													'{{ attachment.filename }}'
												)
											);
											?>
											"
										<# } #>
									/>
									<# if ( index === 5 && data.ids.length > 6 ) { #>
									<div class="gallery-icon-placeholder">
										<p class="gallery-icon-placeholder-text" aria-label="
										<?php
											printf(
												/* translators: %s: The amount of additional, not visible images in the gallery widget preview. */
												__( 'Additional images added to this gallery: %s' ),
												'{{ data.ids.length - 5 }}'
											);
										?>
										">+{{ data.ids.length - 5 }}</p>
									</div>
									<# } #>
								</div>
							</li>
						<# } #>
					<# } ); #>
				</ul>
			<# } else { #>
				<div class="attachment-media-view">
					<button type="button" class="placeholder button-add-media"><?php echo esc_html( $this->l10n['add_media'] ); ?></button>
				</div>
			<# } #>
		</script>
		<?php
	}

	/**
	 * Whether the widget has content to show.
	 *
	 * @since 4.9.0
	 * @access protected
	 *
	 * @param array $instance Widget instance props.
	 * @return bool Whether widget has content.
	 */
	protected function has_content( $instance ) {
		if ( ! empty( $instance['ids'] ) ) {
			$attachments = wp_parse_id_list( $instance['ids'] );
			foreach ( $attachments as $attachment ) {
				if ( 'attachment' !== get_post_type( $attachment ) ) {
					return false;
				}
			}
			return true;
		}
		return false;
	}
}

カスタマイズ例：デフォルトのウィジェットタイトルを変更してみる

今回は、カスタマイズの一例として「デフォルトのウィジェットタイトル」を変更してみようと思います。

デフォルトでは、下記のようにタイトルは空白になっています。

<?php
~
//省略
~
public function get_instance_schema() {
		$schema = array(
			'title'          => array(
				'type'                  => 'string',

				//デフォルトは、空白になっている
				'default'               => '',

				'sanitize_callback'     => 'sanitize_text_field',
				'description'           => __( 'Title for the widget' ),
				'should_preview_update' => false,
			),

~
//省略
~

コードを下記のように変更します。

</php
~
//省略
~
public function get_instance_schema() {
		$schema = array(
			'title'          => array(
				'type'                  => 'string',

				//デフォルトのタイトルを変更する
				'default'               => 'デフォルトのタイトル変更',

				'sanitize_callback'     => 'sanitize_text_field',
				'description'           => __( 'Title for the widget' ),
				'should_preview_update' => false,
			),

~
//省略
~

コードを変更すると、下記のようにデフォルトのタイトルが変更されます。