Mini Shell
<?php // phpcs:ignore eWordPress.Files.FileName.InvalidClassFileName
/**
* Module Name: Gallery widget
*
* @package automattic/jetpack
*/
// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
use Automattic\Jetpack\Assets;
/**
* Jetpack_Gallery_Widget main class.
*/
class Jetpack_Gallery_Widget extends WP_Widget {
const THUMB_SIZE = 45;
const DEFAULT_WIDTH = 265;
/**
* The width of the gallery widget.
* May be customized by the 'gallery_widget_content_width' filter.
*
* @var int
*/
protected $instance_width;
/**
* Jetpack_Gallery_Widget constructor.
*/
public function __construct() {
$widget_ops = array(
'classname' => 'widget-gallery',
'description' => __( 'Display a photo gallery or slideshow', 'jetpack' ),
'customize_selective_refresh' => true,
);
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );
parent::__construct(
'gallery',
/** This filter is documented in modules/widgets/facebook-likebox.php */
apply_filters( 'jetpack_widget_name', __( 'Gallery', 'jetpack' ) ),
$widget_ops
);
if ( is_customize_preview() ) {
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_frontend_scripts' ) );
if ( class_exists( 'Jetpack_Tiled_Gallery' ) ) {
add_action( 'wp_enqueue_scripts', array( 'Jetpack_Tiled_Gallery', 'default_scripts_and_styles' ) );
}
if ( class_exists( 'Jetpack_Slideshow_Shortcode' ) ) {
$slideshow = new Jetpack_Slideshow_Shortcode();
add_action( 'wp_enqueue_scripts', array( $slideshow, 'enqueue_scripts' ) );
}
if ( class_exists( 'Jetpack_Carousel' ) ) {
$carousel = new Jetpack_Carousel();
add_action( 'wp_enqueue_scripts', array( $carousel, 'enqueue_assets' ) );
}
}
}
/**
* Display the widget.
*
* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
* @param array $instance The settings for the particular instance of the widget.
*/
public function widget( $args, $instance ) {
$instance = wp_parse_args( (array) $instance, $this->defaults() );
$this->enqueue_frontend_scripts();
$before_widget = isset( $args['before_widget'] ) ? $args['before_widget'] : '';
$before_title = isset( $args['before_title'] ) ? $args['before_title'] : '';
$after_title = isset( $args['after_title'] ) ? $args['after_title'] : '';
$after_widget = isset( $args['after_widget'] ) ? $args['after_widget'] : '';
$instance['attachments'] = $this->get_attachments( $instance );
$classes = array();
$classes[] = 'widget-gallery-' . $instance['type'];
/*
* Due to a bug in the carousel plugin,
* carousels will be triggered for all tiled galleries that exist on a page with other tiled galleries,
* regardless of whether or not the widget was set to Carousel mode.
* The onClick selector is simply too broad, since it was not written with widgets in mind.
* This special class prevents that behavior, via an override handler in gallery.js.
*/
if ( 'carousel' !== $instance['link'] && 'slideshow' !== $instance['type'] ) {
$classes[] = 'no-carousel';
} else {
$classes[] = 'carousel';
}
$classes = implode( ' ', $classes );
if ( 'carousel' === $instance['link'] ) {
require_once plugin_dir_path( realpath( __DIR__ . '/../carousel/jetpack-carousel.php' ) ) . 'jetpack-carousel.php';
if ( class_exists( 'Jetpack_Carousel' ) ) {
// Create new carousel so we can use the enqueue_assets() method. Not ideal, but there is a decent amount
// of logic in that method that shouldn't be duplicated.
$carousel = new Jetpack_Carousel();
// First parameter is $output, which comes from filters, and causes bypass of the asset enqueuing. Passing null is correct.
$carousel->enqueue_assets( null );
}
}
echo $before_widget . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
/** This filter is documented in core/src/wp-includes/default-widgets.php */
$title = apply_filters( 'widget_title', $instance['title'] );
if ( $title ) {
echo $before_title . $title . $after_title . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
echo '<div class="' . esc_attr( $classes ) . '">' . "\n";
$method = $instance['type'] . '_widget';
/**
* Allow the width of a gallery to be altered by themes or other code.
*
* @module widgets
*
* @since 2.5.0
*
* @param int self::DEFAULT_WIDTH Default gallery width. Default is 265.
* @param string $args Display arguments including before_title, after_title, before_widget, and after_widget.
* @param array $instance The settings for the particular instance of the widget.
*/
$this->instance_width = apply_filters( 'gallery_widget_content_width', self::DEFAULT_WIDTH, $args, $instance );
// Register a filter to modify the tiled_gallery_content_width, so Jetpack_Tiled_Gallery
// can appropriately size the tiles.
add_filter( 'tiled_gallery_content_width', array( $this, 'tiled_gallery_content_width' ) );
if ( method_exists( $this, $method ) ) {
echo $this->$method( $args, $instance ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
// Remove the stored $instance_width, as it is no longer needed.
$this->instance_width = null;
// Remove the filter, so any Jetpack_Tiled_Gallery in a post is not affected.
remove_filter( 'tiled_gallery_content_width', array( $this, 'tiled_gallery_content_width' ) );
echo "\n" . '</div>'; // .widget-gallery-$type
echo "\n" . $after_widget; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
/** This action is documented in modules/widgets/gravatar-profile.php */
do_action( 'jetpack_stats_extra', 'widget_view', 'gallery' );
}
/**
* Fetch the images attached to the gallery Widget
*
* @param array $instance The Widget instance for which you'd like attachments.
* @return array Array of attachment objects for the Widget in $instance
*/
public function get_attachments( $instance ) {
$ids = explode( ',', $instance['ids'] );
if ( isset( $instance['random'] ) && 'on' === $instance['random'] ) {
shuffle( $ids );
}
$attachments_query = new WP_Query(
array(
'post__in' => $ids,
'post_status' => 'inherit',
'post_type' => 'attachment',
'post_mime_type' => 'image',
'posts_per_page' => -1,
'orderby' => 'post__in',
)
);
$attachments = $attachments_query->get_posts();
wp_reset_postdata();
return $attachments;
}
/**
* Generate HTML for a rectangular, tiled Widget
*
* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
* @param array $instance The Widget instance to generate HTML for.
* @return string String of HTML representing a rectangular gallery
*/
public function rectangular_widget( $args, $instance ) {
if ( ! class_exists( 'Jetpack_Tiled_Gallery' )
&& ! class_exists( 'Jetpack_Tiled_Gallery_Layout_Rectangular' ) ) {
return;
}
Jetpack_Tiled_Gallery::default_scripts_and_styles();
$layout = new Jetpack_Tiled_Gallery_Layout_Rectangular( $instance['attachments'], $instance['link'], false, 3 );
return $layout->HTML();
}
/**
* Generate HTML for a square (grid style) Widget
*
* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
* @param array $instance The Widget instance to generate HTML for.
* @return string String of HTML representing a square gallery
*/
public function square_widget( $args, $instance ) {
if ( ! class_exists( 'Jetpack_Tiled_Gallery' )
&& ! class_exists( 'Jetpack_Tiled_Gallery_Layout_Square' ) ) {
return;
}
Jetpack_Tiled_Gallery::default_scripts_and_styles();
$layout = new Jetpack_Tiled_Gallery_Layout_Square( $instance['attachments'], $instance['link'], false, 3 );
return $layout->HTML();
}
/**
* Generate HTML for a circular (grid style) Widget
*
* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
* @param array $instance The Widget instance to generate HTML for.
* @return string String of HTML representing a circular gallery
*/
public function circle_widget( $args, $instance ) {
if ( ! class_exists( 'Jetpack_Tiled_Gallery' )
&& ! class_exists( 'Jetpack_Tiled_Gallery_Layout_Circle' ) ) {
return;
}
Jetpack_Tiled_Gallery::default_scripts_and_styles();
$layout = new Jetpack_Tiled_Gallery_Layout_Circle( $instance['attachments'], $instance['link'], false, 3 );
return $layout->HTML();
}
/**
* Generate HTML for a slideshow Widget
*
* @todo Is slideshow_widget() still used?
*
* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
* @param array $instance The Widget instance to generate HTML for.
* @return string String of HTML representing a slideshow gallery
*/
public function slideshow_widget( $args, $instance ) {
global $content_width;
require_once plugin_dir_path( realpath( __DIR__ . '/../shortcodes/slideshow.php' ) ) . 'slideshow.php';
if ( ! class_exists( 'Jetpack_Slideshow_Shortcode' ) ) {
return;
}
if ( count( $instance['attachments'] ) < 1 ) {
return;
}
$slideshow = new Jetpack_Slideshow_Shortcode();
$slideshow->enqueue_scripts();
$gallery_instance = 'widget-' . $args['widget_id'];
$gallery = array();
foreach ( $instance['attachments'] as $attachment ) {
$attachment_image_src = wp_get_attachment_image_src( $attachment->ID, 'full' );
$attachment_image_src = jetpack_photon_url( $attachment_image_src[0], array( 'w' => $this->instance_width ) ); /** [url, width, height] */
$caption = wptexturize( wp_strip_all_tags( $attachment->post_excerpt ) );
$gallery[] = (object) array(
'src' => (string) esc_url_raw( $attachment_image_src ),
'id' => (string) $attachment->ID,
'caption' => (string) $caption,
);
}
$max_width = (int) get_option( 'large_size_w' );
$max_height = 175;
if ( (int) $content_width > 0 ) {
$max_width = min( (int) $content_width, $max_width );
}
$color = Jetpack_Options::get_option( 'slideshow_background_color', 'black' );
$autostart = isset( $attr['autostart'] ) ? $attr['autostart'] : true; // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable -- Todo: should read off the $instance? Also not sure if slideshow_widget() is used still.
$js_attr = array(
'gallery' => $gallery,
'selector' => $gallery_instance,
'width' => $max_width,
'height' => $max_height,
'trans' => 'fade',
'color' => $color,
'autostart' => $autostart,
);
$html = $slideshow->slideshow_js( $js_attr );
return $html;
}
/**
* Used to adjust the content width of Jetpack_Tiled_Gallery's in sidebars
*
* $this->instance_width is filtered in widget() and this filter is added then removed in widget()
*
* @return int The filtered width
*/
public function tiled_gallery_content_width() {
return $this->instance_width;
}
/**
* Outputs the widget settings form.
*
* @param array $instance Current settings.
*/
public function form( $instance ) {
$defaults = $this->defaults();
$allowed_values = $this->allowed_values(); // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- Used in included form template.
$instance = wp_parse_args( (array) $instance, $defaults );
include __DIR__ . '/gallery/templates/form.php';
}
/**
* Save the widget options.
*
* @param array $new_instance The new instance options.
* @param array $old_instance The old instance options.
* @return array The saved options.
*/
public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
$instance = $this->sanitize( $new_instance );
return $instance;
}
/**
* Sanitize the $instance's values to the set of allowed values. If a value is not acceptable,
* it is set to its default.
*
* Helps keep things nice and secure by listing only allowed values.
*
* @param array $instance The Widget instance to sanitize values for.
* @return array $instance The Widget instance with values sanitized
*/
public function sanitize( $instance ) {
$allowed_values = $this->allowed_values();
$defaults = $this->defaults();
foreach ( $instance as $key => $value ) {
if ( ! is_scalar( $value ) ) {
// $instance may hold an Array value type for the Jetpack widget visibility feature.
continue;
}
$value = trim( $value );
if ( isset( $allowed_values[ $key ] ) && $allowed_values[ $key ] && ! array_key_exists( $value, $allowed_values[ $key ] ) ) {
$instance[ $key ] = $defaults[ $key ];
} else {
$instance[ $key ] = sanitize_text_field( $value );
}
}
return $instance;
}
/**
* Return a multi-dimensional array of allowed values (and their labels) for all widget form
* elements
*
* To allow all values on an input, omit it from the returned array
*
* @return array Array of allowed values for each option
*/
public function allowed_values() {
$max_columns = 5;
// Create an associative array of allowed column values. This just automates the generation of
// column <option>s, from 1 to $max_columns.
$allowed_columns = array_combine( range( 1, $max_columns ), range( 1, $max_columns ) );
return array(
'type' => array(
'rectangular' => __( 'Tiles', 'jetpack' ),
'square' => __( 'Square Tiles', 'jetpack' ),
'circle' => __( 'Circles', 'jetpack' ),
'slideshow' => __( 'Slideshow', 'jetpack' ),
),
'columns' => $allowed_columns,
'link' => array(
'carousel' => __( 'Carousel', 'jetpack' ),
'post' => __( 'Attachment Page', 'jetpack' ),
'file' => __( 'Media File', 'jetpack' ),
),
);
}
/**
* Return an associative array of default values
*
* These values are used in new widgets as well as when sanitizing input. If a given value is not allowed,
* as defined in allowed_values(), that input is set to the default value defined here.
*
* @return array Array of default values for the Widget's options
*/
public function defaults() {
return array(
'title' => '',
'type' => 'rectangular',
'ids' => '',
'columns' => 3,
'link' => 'carousel',
);
}
/**
* Enqueue frontend scripts.
*/
public function enqueue_frontend_scripts() {
wp_register_script(
'gallery-widget',
Assets::get_file_url_for_environment(
'_inc/build/widgets/gallery/js/gallery.min.js',
'modules/widgets/gallery/js/gallery.js'
),
array( 'jquery' ),
JETPACK__VERSION,
false
);
wp_enqueue_script( 'gallery-widget' );
}
/**
* Enqueue admin scripts and styles.
*/
public function enqueue_admin_scripts() {
global $pagenow;
if ( 'widgets.php' === $pagenow || 'customize.php' === $pagenow ) {
wp_enqueue_media();
wp_enqueue_script(
'gallery-widget-admin',
Assets::get_file_url_for_environment(
'_inc/build/widgets/gallery/js/admin.min.js',
'modules/widgets/gallery/js/admin.js'
),
array(
'jquery',
'media-models',
'media-views',
),
'20150501',
false
);
$js_settings = array(
'thumbSize' => self::THUMB_SIZE,
);
wp_localize_script( 'gallery-widget-admin', '_wpGalleryWidgetAdminSettings', $js_settings );
wp_enqueue_style(
'gallery-widget-admin',
plugins_url( '/gallery/css/admin.css', __FILE__ ),
array(),
JETPACK__VERSION
);
wp_style_add_data( 'gallery-widget-admin', 'rtl', 'replace' );
}
}
}
add_action( 'widgets_init', 'jetpack_gallery_widget_init' );
/**
* Jetpack Gallery widget init; the widget is conditionally registered.
*/
function jetpack_gallery_widget_init() {
/**
* Allow the Gallery Widget to be enabled even when Core supports the Media Gallery Widget
*
* @module widgets
*
* @since 5.5.0
*
* @param bool false Whether to force-enable the gallery widget
*/
if (
! apply_filters( 'jetpack_force_enable_gallery_widget', false )
&& class_exists( 'WP_Widget_Media_Gallery' )
&& Jetpack_Options::get_option( 'gallery_widget_migration' )
) {
return;
}
if ( ! method_exists( 'Jetpack', 'is_module_active' ) || Jetpack::is_module_active( 'tiled-gallery' ) ) {
register_widget( 'Jetpack_Gallery_Widget' );
}
}
Zerion Mini Shell 1.0