mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-07-01 07:40:07 +00:00
Widgets: Introduce Gallery widget for displaying image galleries.
* Galleries are managed in the widget in the same way they are managed in the post editor, both using the media manager. * Gallery widget is merged from the Core Media Widgets v0.2.0 feature plugin and it extends `WP_Widget_Media` in the same way as is done for image, audio, and video widgets. * Model syncing logic is updated to support booleans and arrays (of integers). * Placeholder areas in media widgets are now clickable shortcuts for selecting media. * Image widget placeholder is updated to match gallery widget where clicking preview is shortcut for editing media. Props westonruter, joemcgill, timmydcrawford, m1tk00, obenland, melchoyce. See #32417. Fixes #41914. git-svn-id: https://develop.svn.wordpress.org/trunk@41590 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Weston Ruter
224
src/wp-includes/widgets/class-wp-widget-media-gallery.php
Normal file
224
src/wp-includes/widgets/class-wp-widget-media-gallery.php
Normal file
@@ -0,0 +1,224 @@
|
||||
<?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
|
||||
*/
|
||||
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( 'Select Images', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),
|
||||
'replace_media' => _x( 'Replace Gallery', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),
|
||||
'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() {
|
||||
return 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( 'none', 'file', 'post' ),
|
||||
'default' => 'none',
|
||||
'media_prop' => 'link',
|
||||
'should_preview_update' => false,
|
||||
),
|
||||
'orderby_random' => array(
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'media_prop' => '_orderbyRandom',
|
||||
'should_preview_update' => false,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the media on the frontend.
|
||||
*
|
||||
* @since 4.9.0
|
||||
*
|
||||
* @param array $instance Widget instance props.
|
||||
* @return void
|
||||
*/
|
||||
public function render_media( $instance ) {
|
||||
$instance = array_merge( wp_list_pluck( $this->get_instance_schema(), 'default' ), $instance );
|
||||
|
||||
$shortcode_atts = array(
|
||||
'ids' => $instance['ids'],
|
||||
'columns' => $instance['columns'],
|
||||
'link' => $instance['link_type'],
|
||||
'size' => $instance['size'],
|
||||
);
|
||||
|
||||
// @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 describedById = 'describedBy-' + String( Math.random() ); #>
|
||||
<# if ( data.ids.length ) { #>
|
||||
<div class="gallery media-widget-gallery-preview">
|
||||
<# _.each( data.ids, function( id, index ) { #>
|
||||
<#
|
||||
var attachment = data.attachments[ id ];
|
||||
if ( ! attachment ) {
|
||||
return;
|
||||
}
|
||||
#>
|
||||
<# if ( index < 6 ) { #>
|
||||
<dl class="gallery-item">
|
||||
<dt class="gallery-icon">
|
||||
<# if ( attachment.sizes.thumbnail ) { #>
|
||||
<img src="{{ attachment.sizes.thumbnail.url }}" width="{{ attachment.sizes.thumbnail.width }}" height="{{ attachment.sizes.thumbnail.height }}" alt="" />
|
||||
<# } else { #>
|
||||
<img src="{{ attachment.url }}" alt="" />
|
||||
<# } #>
|
||||
<# if ( index === 5 && data.ids.length > 6 ) { #>
|
||||
<div class="gallery-icon-placeholder">
|
||||
<p class="gallery-icon-placeholder-text">+{{ data.ids.length - 5 }}</p>
|
||||
</div>
|
||||
<# } #>
|
||||
</dt>
|
||||
</dl>
|
||||
<# } #>
|
||||
<# } ); #>
|
||||
</div>
|
||||
<# } else { #>
|
||||
<div class="attachment-media-view">
|
||||
<p class="placeholder"><?php echo esc_html( $this->l10n['no_media_selected'] ); ?></p>
|
||||
</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;
|
||||
}
|
||||
}
|
||||
@@ -257,6 +257,12 @@ abstract class WP_Widget_Media extends WP_Widget {
|
||||
continue;
|
||||
}
|
||||
$value = $new_instance[ $field ];
|
||||
|
||||
// Workaround for rest_validate_value_from_schema() due to the fact that rest_is_boolean( '' ) === false, while rest_is_boolean( '1' ) is true.
|
||||
if ( 'boolean' === $field_schema['type'] && '' === $value ) {
|
||||
$value = false;
|
||||
}
|
||||
|
||||
if ( true !== rest_validate_value_from_schema( $value, $field_schema, $field ) ) {
|
||||
continue;
|
||||
}
|
||||
@@ -316,7 +322,7 @@ abstract class WP_Widget_Media extends WP_Widget {
|
||||
class="media-widget-instance-property"
|
||||
name="<?php echo esc_attr( $this->get_field_name( $name ) ); ?>"
|
||||
id="<?php echo esc_attr( $this->get_field_id( $name ) ); // Needed specifically by wpWidgets.appendTitle(). ?>"
|
||||
value="<?php echo esc_attr( strval( $value ) ); ?>"
|
||||
value="<?php echo esc_attr( is_array( $value ) ? join( ',', $value ) : strval( $value ) ); ?>"
|
||||
/>
|
||||
<?php
|
||||
endforeach;
|
||||
@@ -388,7 +394,7 @@ abstract class WP_Widget_Media extends WP_Widget {
|
||||
<label for="{{ elementIdPrefix }}title"><?php esc_html_e( 'Title:' ); ?></label>
|
||||
<input id="{{ elementIdPrefix }}title" type="text" class="widefat title">
|
||||
</p>
|
||||
<div class="media-widget-preview">
|
||||
<div class="media-widget-preview <?php echo esc_attr( $this->id_base ); ?>">
|
||||
<div class="attachment-media-view">
|
||||
<div class="placeholder"><?php echo esc_html( $this->l10n['no_media_selected'] ); ?></div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user