Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Widget API: WP_Widget_Media_Gallery class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Widgets

[5] Fix | Delete

* @since 4.9.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class that implements a gallery widget.

[10] Fix | Delete

[11] Fix | Delete

* @since 4.9.0

[12] Fix | Delete

[13] Fix | Delete

* @see WP_Widget_Media

[14] Fix | Delete

* @see WP_Widget

[15] Fix | Delete

[16] Fix | Delete

class WP_Widget_Media_Gallery extends WP_Widget_Media {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Constructor.

[20] Fix | Delete

[21] Fix | Delete

* @since 4.9.0

[22] Fix | Delete

[23] Fix | Delete

public function __construct() {

[24] Fix | Delete

parent::__construct(

[25] Fix | Delete

'media_gallery',

[26] Fix | Delete

__( 'Gallery' ),

[27] Fix | Delete

array(

[28] Fix | Delete

'description' => __( 'Displays an image gallery.' ),

[29] Fix | Delete

'mime_type' => 'image',

[30] Fix | Delete

)

[31] Fix | Delete

);

[32] Fix | Delete

[33] Fix | Delete

$this->l10n = array_merge(

[34] Fix | Delete

$this->l10n,

[35] Fix | Delete

array(

[36] Fix | Delete

'no_media_selected' => __( 'No images selected' ),

[37] Fix | Delete

'add_media' => _x( 'Add Images', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),

[38] Fix | Delete

'replace_media' => '',

[39] Fix | Delete

'edit_media' => _x( 'Edit Gallery', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),

[40] Fix | Delete

)

[41] Fix | Delete

);

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Get schema for properties of a widget instance (item).

[46] Fix | Delete

[47] Fix | Delete

* @since 4.9.0

[48] Fix | Delete

[49] Fix | Delete

* @see WP_REST_Controller::get_item_schema()

[50] Fix | Delete

* @see WP_REST_Controller::get_additional_fields()

[51] Fix | Delete

* @link https://core.trac.wordpress.org/ticket/35574

[52] Fix | Delete

[53] Fix | Delete

* @return array Schema for properties.

[54] Fix | Delete

[55] Fix | Delete

public function get_instance_schema() {

[56] Fix | Delete

$schema = array(

[57] Fix | Delete

'title' => array(

[58] Fix | Delete

'type' => 'string',

[59] Fix | Delete

'default' => '',

[60] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[61] Fix | Delete

'description' => __( 'Title for the widget' ),

[62] Fix | Delete

'should_preview_update' => false,

[63] Fix | Delete

[64] Fix | Delete

'ids' => array(

[65] Fix | Delete

'type' => 'array',

[66] Fix | Delete

'items' => array(

[67] Fix | Delete

'type' => 'integer',

[68] Fix | Delete

[69] Fix | Delete

'default' => array(),

[70] Fix | Delete

'sanitize_callback' => 'wp_parse_id_list',

[71] Fix | Delete

[72] Fix | Delete

'columns' => array(

[73] Fix | Delete

'type' => 'integer',

[74] Fix | Delete

'default' => 3,

[75] Fix | Delete

'minimum' => 1,

[76] Fix | Delete

'maximum' => 9,

[77] Fix | Delete

[78] Fix | Delete

'size' => array(

[79] Fix | Delete

'type' => 'string',

[80] Fix | Delete

'enum' => array_merge( get_intermediate_image_sizes(), array( 'full', 'custom' ) ),

[81] Fix | Delete

'default' => 'thumbnail',

[82] Fix | Delete

[83] Fix | Delete

'link_type' => array(

[84] Fix | Delete

'type' => 'string',

[85] Fix | Delete

'enum' => array( 'post', 'file', 'none' ),

[86] Fix | Delete

'default' => 'post',

[87] Fix | Delete

'media_prop' => 'link',

[88] Fix | Delete

'should_preview_update' => false,

[89] Fix | Delete

[90] Fix | Delete

'orderby_random' => array(

[91] Fix | Delete

'type' => 'boolean',

[92] Fix | Delete

'default' => false,

[93] Fix | Delete

'media_prop' => '_orderbyRandom',

[94] Fix | Delete

'should_preview_update' => false,

[95] Fix | Delete

[96] Fix | Delete

);

[97] Fix | Delete

[98] Fix | Delete

/** This filter is documented in wp-includes/widgets/class-wp-widget-media.php */

[99] Fix | Delete

$schema = apply_filters( "widget_{$this->id_base}_instance_schema", $schema, $this );

[100] Fix | Delete

[101] Fix | Delete

return $schema;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/**

[105] Fix | Delete

* Render the media on the frontend.

[106] Fix | Delete

[107] Fix | Delete

* @since 4.9.0

[108] Fix | Delete

[109] Fix | Delete

* @param array $instance Widget instance props.

[110] Fix | Delete

[111] Fix | Delete

public function render_media( $instance ) {

[112] Fix | Delete

$instance = array_merge( wp_list_pluck( $this->get_instance_schema(), 'default' ), $instance );

[113] Fix | Delete

[114] Fix | Delete

$shortcode_atts = array_merge(

[115] Fix | Delete

$instance,

[116] Fix | Delete

array(

[117] Fix | Delete

'link' => $instance['link_type'],

[118] Fix | Delete

)

[119] Fix | Delete

);

[120] Fix | Delete

[121] Fix | Delete

// @codeCoverageIgnoreStart

[122] Fix | Delete

if ( $instance['orderby_random'] ) {

[123] Fix | Delete

$shortcode_atts['orderby'] = 'rand';

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

// @codeCoverageIgnoreEnd

[127] Fix | Delete

echo gallery_shortcode( $shortcode_atts );

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Loads the required media files for the media manager and scripts for media widgets.

[132] Fix | Delete

[133] Fix | Delete

* @since 4.9.0

[134] Fix | Delete

[135] Fix | Delete

public function enqueue_admin_scripts() {

[136] Fix | Delete

parent::enqueue_admin_scripts();

[137] Fix | Delete

[138] Fix | Delete

$handle = 'media-gallery-widget';

[139] Fix | Delete

wp_enqueue_script( $handle );

[140] Fix | Delete

[141] Fix | Delete

$exported_schema = array();

[142] Fix | Delete

foreach ( $this->get_instance_schema() as $field => $field_schema ) {

[143] Fix | Delete

$exported_schema[ $field ] = wp_array_slice_assoc( $field_schema, array( 'type', 'default', 'enum', 'minimum', 'format', 'media_prop', 'should_preview_update', 'items' ) );

[144] Fix | Delete

}

[145] Fix | Delete

wp_add_inline_script(

[146] Fix | Delete

$handle,

[147] Fix | Delete

sprintf(

[148] Fix | Delete

'wp.mediaWidgets.modelConstructors[ %s ].prototype.schema = %s;',

[149] Fix | Delete

wp_json_encode( $this->id_base ),

[150] Fix | Delete

wp_json_encode( $exported_schema )

[151] Fix | Delete

)

[152] Fix | Delete

);

[153] Fix | Delete

[154] Fix | Delete

wp_add_inline_script(

[155] Fix | Delete

$handle,

[156] Fix | Delete

sprintf(

[157] Fix | Delete

[158] Fix | Delete

wp.mediaWidgets.controlConstructors[ %1$s ].prototype.mime_type = %2$s;

[159] Fix | Delete

_.extend( wp.mediaWidgets.controlConstructors[ %1$s ].prototype.l10n, %3$s );

[160] Fix | Delete

[161] Fix | Delete

wp_json_encode( $this->id_base ),

[162] Fix | Delete

wp_json_encode( $this->widget_options['mime_type'] ),

[163] Fix | Delete

wp_json_encode( $this->l10n )

[164] Fix | Delete

)

[165] Fix | Delete

);

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Render form template scripts.

[170] Fix | Delete

[171] Fix | Delete

* @since 4.9.0

[172] Fix | Delete

[173] Fix | Delete

public function render_control_template_scripts() {

[174] Fix | Delete

parent::render_control_template_scripts();

[175] Fix | Delete

[176] Fix | Delete

[177] Fix | Delete

[178] Fix | Delete

var ids = _.filter( data.ids, function( id ) {

[179] Fix | Delete

return ( id in data.attachments );

[180] Fix | Delete

} );

[181] Fix | Delete

[182] Fix | Delete

<# if ( ids.length ) { #>

[183] Fix | Delete

[184] Fix | Delete

<# _.each( ids, function( id, index ) { #>

[185] Fix | Delete

<# var attachment = data.attachments[ id ]; #>

[186] Fix | Delete

<# if ( index < 6 ) { #>

[187] Fix | Delete

[188] Fix | Delete

[189] Fix | Delete

<img alt="{{ attachment.alt }}"

[190] Fix | Delete

<# if ( index === 5 && data.ids.length > 6 ) { #> aria-hidden="true" <# } #>

[191] Fix | Delete

<# if ( attachment.sizes.thumbnail ) { #>

[192] Fix | Delete

src="{{ attachment.sizes.thumbnail.url }}" width="{{ attachment.sizes.thumbnail.width }}" height="{{ attachment.sizes.thumbnail.height }}"

[193] Fix | Delete

<# } else { #>

[194] Fix | Delete

src="{{ attachment.url }}"

[195] Fix | Delete

<# } #>

[196] Fix | Delete

<# if ( ! attachment.alt && attachment.filename ) { #>

[197] Fix | Delete

aria-label="

[198] Fix | Delete

<?php

[199] Fix | Delete

echo esc_attr(

[200] Fix | Delete

sprintf(

[201] Fix | Delete

/* translators: %s: The image file name. */

[202] Fix | Delete

__( 'The current image has no alternative text. The file name is: %s' ),

[203] Fix | Delete

'{{ attachment.filename }}'

[204] Fix | Delete

)

[205] Fix | Delete

);

[206] Fix | Delete

[207] Fix | Delete

[208] Fix | Delete

<# } #>

[209] Fix | Delete

[210] Fix | Delete

<# if ( index === 5 && data.ids.length > 6 ) { #>

[211] Fix | Delete

[212] Fix | Delete

<p class="gallery-icon-placeholder-text" aria-label="

[213] Fix | Delete

<?php

[214] Fix | Delete

printf(

[215] Fix | Delete

/* translators: %s: The amount of additional, not visible images in the gallery widget preview. */

[216] Fix | Delete

__( 'Additional images added to this gallery: %s' ),

[217] Fix | Delete

'{{ data.ids.length - 5 }}'

[218] Fix | Delete

);

[219] Fix | Delete

[220] Fix | Delete

">+{{ data.ids.length - 5 }}</p>

[221] Fix | Delete

</div>

[222] Fix | Delete

<# } #>

[223] Fix | Delete

</div>

[224] Fix | Delete

</li>

[225] Fix | Delete

<# } #>

[226] Fix | Delete

<# } ); #>

[227] Fix | Delete

</ul>

[228] Fix | Delete

<# } else { #>

[229] Fix | Delete

[230] Fix | Delete

<button type="button" class="placeholder button-add-media"><?php echo esc_html( $this->l10n['add_media'] ); ?></button>

[231] Fix | Delete

</div>

[232] Fix | Delete

<# } #>

[233] Fix | Delete

</script>

[234] Fix | Delete

<?php

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

/**

[238] Fix | Delete

* Whether the widget has content to show.

[239] Fix | Delete

[240] Fix | Delete

* @since 4.9.0

[241] Fix | Delete

* @access protected

[242] Fix | Delete

[243] Fix | Delete

* @param array $instance Widget instance props.

[244] Fix | Delete

* @return bool Whether widget has content.

[245] Fix | Delete

[246] Fix | Delete

protected function has_content( $instance ) {

[247] Fix | Delete

if ( ! empty( $instance['ids'] ) ) {

[248] Fix | Delete

$attachments = wp_parse_id_list( $instance['ids'] );

[249] Fix | Delete

// Prime attachment post caches.

[250] Fix | Delete

_prime_post_caches( $attachments, false, false );

[251] Fix | Delete

foreach ( $attachments as $attachment ) {

[252] Fix | Delete

if ( 'attachment' !== get_post_type( $attachment ) ) {

[253] Fix | Delete

return false;

[254] Fix | Delete

}

[255] Fix | Delete

}

[256] Fix | Delete

return true;

[257] Fix | Delete

}

[258] Fix | Delete

return false;

[259] Fix | Delete

}

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete