Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Widget API: WP_Widget_Media_Image class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Widgets

[5] Fix | Delete

* @since 4.8.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class that implements an image widget.

[10] Fix | Delete

[11] Fix | Delete

* @since 4.8.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_Image extends WP_Widget_Media {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Constructor.

[20] Fix | Delete

[21] Fix | Delete

* @since 4.8.0

[22] Fix | Delete

[23] Fix | Delete

public function __construct() {

[24] Fix | Delete

parent::__construct(

[25] Fix | Delete

'media_image',

[26] Fix | Delete

__( 'Image' ),

[27] Fix | Delete

array(

[28] Fix | Delete

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

[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 image selected' ),

[37] Fix | Delete

'add_media' => _x( 'Add Image', 'label for button in the image widget' ),

[38] Fix | Delete

'replace_media' => _x( 'Replace Image', 'label for button in the image widget; should preferably not be longer than ~13 characters long' ),

[39] Fix | Delete

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

[40] Fix | Delete

'missing_attachment' => sprintf(

[41] Fix | Delete

/* translators: %s: URL to media library. */

[42] Fix | Delete

__( 'That image cannot be found. Check your <a href="%s">media library</a> and make sure it was not deleted.' ),

[43] Fix | Delete

esc_url( admin_url( 'upload.php' ) )

[44] Fix | Delete

[45] Fix | Delete

/* translators: %d: Widget count. */

[46] Fix | Delete

'media_library_state_multi' => _n_noop( 'Image Widget (%d)', 'Image Widget (%d)' ),

[47] Fix | Delete

'media_library_state_single' => __( 'Image Widget' ),

[48] Fix | Delete

)

[49] Fix | Delete

);

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

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

[54] Fix | Delete

[55] Fix | Delete

* @since 4.8.0

[56] Fix | Delete

[57] Fix | Delete

* @see WP_REST_Controller::get_item_schema()

[58] Fix | Delete

* @see WP_REST_Controller::get_additional_fields()

[59] Fix | Delete

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

[60] Fix | Delete

[61] Fix | Delete

* @return array Schema for properties.

[62] Fix | Delete

[63] Fix | Delete

public function get_instance_schema() {

[64] Fix | Delete

return array_merge(

[65] Fix | Delete

array(

[66] Fix | Delete

'size' => array(

[67] Fix | Delete

'type' => 'string',

[68] Fix | Delete

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

[69] Fix | Delete

'default' => 'medium',

[70] Fix | Delete

'description' => __( 'Size' ),

[71] Fix | Delete

[72] Fix | Delete

'width' => array( // Via 'customWidth', only when size=custom; otherwise via 'width'.

[73] Fix | Delete

'type' => 'integer',

[74] Fix | Delete

'minimum' => 0,

[75] Fix | Delete

'default' => 0,

[76] Fix | Delete

'description' => __( 'Width' ),

[77] Fix | Delete

[78] Fix | Delete

'height' => array( // Via 'customHeight', only when size=custom; otherwise via 'height'.

[79] Fix | Delete

'type' => 'integer',

[80] Fix | Delete

'minimum' => 0,

[81] Fix | Delete

'default' => 0,

[82] Fix | Delete

'description' => __( 'Height' ),

[83] Fix | Delete

[84] Fix | Delete

[85] Fix | Delete

'caption' => array(

[86] Fix | Delete

'type' => 'string',

[87] Fix | Delete

'default' => '',

[88] Fix | Delete

'sanitize_callback' => 'wp_kses_post',

[89] Fix | Delete

'description' => __( 'Caption' ),

[90] Fix | Delete

'should_preview_update' => false,

[91] Fix | Delete

[92] Fix | Delete

'alt' => array(

[93] Fix | Delete

'type' => 'string',

[94] Fix | Delete

'default' => '',

[95] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[96] Fix | Delete

'description' => __( 'Alternative Text' ),

[97] Fix | Delete

[98] Fix | Delete

'link_type' => array(

[99] Fix | Delete

'type' => 'string',

[100] Fix | Delete

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

[101] Fix | Delete

'default' => 'custom',

[102] Fix | Delete

'media_prop' => 'link',

[103] Fix | Delete

'description' => __( 'Link To' ),

[104] Fix | Delete

'should_preview_update' => true,

[105] Fix | Delete

[106] Fix | Delete

'link_url' => array(

[107] Fix | Delete

'type' => 'string',

[108] Fix | Delete

'default' => '',

[109] Fix | Delete

'format' => 'uri',

[110] Fix | Delete

'media_prop' => 'linkUrl',

[111] Fix | Delete

'description' => __( 'URL' ),

[112] Fix | Delete

'should_preview_update' => true,

[113] Fix | Delete

[114] Fix | Delete

'image_classes' => array(

[115] Fix | Delete

'type' => 'string',

[116] Fix | Delete

'default' => '',

[117] Fix | Delete

'sanitize_callback' => array( $this, 'sanitize_token_list' ),

[118] Fix | Delete

'media_prop' => 'extraClasses',

[119] Fix | Delete

'description' => __( 'Image CSS Class' ),

[120] Fix | Delete

'should_preview_update' => false,

[121] Fix | Delete

[122] Fix | Delete

'link_classes' => array(

[123] Fix | Delete

'type' => 'string',

[124] Fix | Delete

'default' => '',

[125] Fix | Delete

'sanitize_callback' => array( $this, 'sanitize_token_list' ),

[126] Fix | Delete

'media_prop' => 'linkClassName',

[127] Fix | Delete

'should_preview_update' => false,

[128] Fix | Delete

'description' => __( 'Link CSS Class' ),

[129] Fix | Delete

[130] Fix | Delete

'link_rel' => array(

[131] Fix | Delete

'type' => 'string',

[132] Fix | Delete

'default' => '',

[133] Fix | Delete

'sanitize_callback' => array( $this, 'sanitize_token_list' ),

[134] Fix | Delete

'media_prop' => 'linkRel',

[135] Fix | Delete

'description' => __( 'Link Rel' ),

[136] Fix | Delete

'should_preview_update' => false,

[137] Fix | Delete

[138] Fix | Delete

'link_target_blank' => array(

[139] Fix | Delete

'type' => 'boolean',

[140] Fix | Delete

'default' => false,

[141] Fix | Delete

'media_prop' => 'linkTargetBlank',

[142] Fix | Delete

'description' => __( 'Open link in a new tab' ),

[143] Fix | Delete

'should_preview_update' => false,

[144] Fix | Delete

[145] Fix | Delete

'image_title' => array(

[146] Fix | Delete

'type' => 'string',

[147] Fix | Delete

'default' => '',

[148] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[149] Fix | Delete

'media_prop' => 'title',

[150] Fix | Delete

'description' => __( 'Image Title Attribute' ),

[151] Fix | Delete

'should_preview_update' => false,

[152] Fix | Delete

[153] Fix | Delete

[154] Fix | Delete

[155] Fix | Delete

* There are two additional properties exposed by the PostImage modal

[156] Fix | Delete

* that don't seem to be relevant, as they may only be derived read-only

[157] Fix | Delete

* values:

[158] Fix | Delete

* - originalUrl

[159] Fix | Delete

* - aspectRatio

[160] Fix | Delete

* - height (redundant when size is not custom)

[161] Fix | Delete

* - width (redundant when size is not custom)

[162] Fix | Delete

[163] Fix | Delete

[164] Fix | Delete

parent::get_instance_schema()

[165] Fix | Delete

);

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

/**

[169] Fix | Delete

* Render the media on the frontend.

[170] Fix | Delete

[171] Fix | Delete

* @since 4.8.0

[172] Fix | Delete

[173] Fix | Delete

* @param array $instance Widget instance props.

[174] Fix | Delete

[175] Fix | Delete

public function render_media( $instance ) {

[176] Fix | Delete

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

[177] Fix | Delete

$instance = wp_parse_args(

[178] Fix | Delete

$instance,

[179] Fix | Delete

array(

[180] Fix | Delete

'size' => 'thumbnail',

[181] Fix | Delete

)

[182] Fix | Delete

);

[183] Fix | Delete

[184] Fix | Delete

$attachment = null;

[185] Fix | Delete

[186] Fix | Delete

if ( $this->is_attachment_with_mime_type( $instance['attachment_id'], $this->widget_options['mime_type'] ) ) {

[187] Fix | Delete

$attachment = get_post( $instance['attachment_id'] );

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

if ( $attachment ) {

[191] Fix | Delete

$caption = '';

[192] Fix | Delete

if ( ! isset( $instance['caption'] ) ) {

[193] Fix | Delete

$caption = $attachment->post_excerpt;

[194] Fix | Delete

} elseif ( trim( $instance['caption'] ) ) {

[195] Fix | Delete

$caption = $instance['caption'];

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

$image_attributes = array(

[199] Fix | Delete

'class' => sprintf( 'image wp-image-%d %s', $attachment->ID, $instance['image_classes'] ),

[200] Fix | Delete

'style' => 'max-width: 100%; height: auto;',

[201] Fix | Delete

);

[202] Fix | Delete

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

[203] Fix | Delete

$image_attributes['title'] = $instance['image_title'];

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

if ( $instance['alt'] ) {

[207] Fix | Delete

$image_attributes['alt'] = $instance['alt'];

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

$size = $instance['size'];

[211] Fix | Delete

[212] Fix | Delete

if ( 'custom' === $size || ! in_array( $size, array_merge( get_intermediate_image_sizes(), array( 'full' ) ), true ) ) {

[213] Fix | Delete

$size = array( $instance['width'], $instance['height'] );

[214] Fix | Delete

$width = $instance['width'];

[215] Fix | Delete

} else {

[216] Fix | Delete

$caption_size = _wp_get_image_size_from_meta( $instance['size'], wp_get_attachment_metadata( $attachment->ID ) );

[217] Fix | Delete

$width = empty( $caption_size[0] ) ? 0 : $caption_size[0];

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

$image_attributes['class'] .= sprintf( ' attachment-%1$s size-%1$s', is_array( $size ) ? implode( 'x', $size ) : $size );

[221] Fix | Delete

[222] Fix | Delete

$image = wp_get_attachment_image( $attachment->ID, $size, false, $image_attributes );

[223] Fix | Delete

[224] Fix | Delete

} else {

[225] Fix | Delete

if ( empty( $instance['url'] ) ) {

[226] Fix | Delete

return;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

$instance['size'] = 'custom';

[230] Fix | Delete

$caption = $instance['caption'];

[231] Fix | Delete

$width = $instance['width'];

[232] Fix | Delete

$classes = 'image ' . $instance['image_classes'];

[233] Fix | Delete

if ( 0 === $instance['width'] ) {

[234] Fix | Delete

$instance['width'] = '';

[235] Fix | Delete

}

[236] Fix | Delete

if ( 0 === $instance['height'] ) {

[237] Fix | Delete

$instance['height'] = '';

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

$attr = array(

[241] Fix | Delete

'class' => $classes,

[242] Fix | Delete

'src' => $instance['url'],

[243] Fix | Delete

'alt' => $instance['alt'],

[244] Fix | Delete

'width' => $instance['width'],

[245] Fix | Delete

'height' => $instance['height'],

[246] Fix | Delete

);

[247] Fix | Delete

[248] Fix | Delete

$loading_optimization_attr = wp_get_loading_optimization_attributes(

[249] Fix | Delete

'img',

[250] Fix | Delete

$attr,

[251] Fix | Delete

'widget_media_image'

[252] Fix | Delete

);

[253] Fix | Delete

[254] Fix | Delete

$attr = array_merge( $attr, $loading_optimization_attr );

[255] Fix | Delete

[256] Fix | Delete

$attr = array_map( 'esc_attr', $attr );

[257] Fix | Delete

$image = '<img';

[258] Fix | Delete

[259] Fix | Delete

foreach ( $attr as $name => $value ) {

[260] Fix | Delete

$image .= ' ' . $name . '="' . $value . '"';

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

$image .= ' />';

[264] Fix | Delete

} // End if().

[265] Fix | Delete

[266] Fix | Delete

$url = '';

[267] Fix | Delete

if ( 'file' === $instance['link_type'] ) {

[268] Fix | Delete

$url = $attachment ? wp_get_attachment_url( $attachment->ID ) : $instance['url'];

[269] Fix | Delete

} elseif ( $attachment && 'post' === $instance['link_type'] ) {

[270] Fix | Delete

$url = get_attachment_link( $attachment->ID );

[271] Fix | Delete

} elseif ( 'custom' === $instance['link_type'] && ! empty( $instance['link_url'] ) ) {

[272] Fix | Delete

$url = $instance['link_url'];

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

if ( $url ) {

[276] Fix | Delete

$link = sprintf( '<a href="%s"', esc_url( $url ) );

[277] Fix | Delete

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

[278] Fix | Delete

$link .= sprintf( ' class="%s"', esc_attr( $instance['link_classes'] ) );

[279] Fix | Delete

}

[280] Fix | Delete

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

[281] Fix | Delete

$link .= sprintf( ' rel="%s"', esc_attr( $instance['link_rel'] ) );

[282] Fix | Delete

}

[283] Fix | Delete

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

[284] Fix | Delete

$link .= ' target="_blank"';

[285] Fix | Delete

}

[286] Fix | Delete

$link .= '>';

[287] Fix | Delete

$link .= $image;

[288] Fix | Delete

$link .= '</a>';

[289] Fix | Delete

$image = wp_targeted_link_rel( $link );

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

if ( $caption ) {

[293] Fix | Delete

$image = img_caption_shortcode(

[294] Fix | Delete

array(

[295] Fix | Delete

'width' => $width,

[296] Fix | Delete

'caption' => $caption,

[297] Fix | Delete

[298] Fix | Delete

$image

[299] Fix | Delete

);

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

echo $image;

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

/**

[306] Fix | Delete

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

[307] Fix | Delete

[308] Fix | Delete

* @since 4.8.0

[309] Fix | Delete

[310] Fix | Delete

public function enqueue_admin_scripts() {

[311] Fix | Delete

parent::enqueue_admin_scripts();

[312] Fix | Delete

[313] Fix | Delete

$handle = 'media-image-widget';

[314] Fix | Delete

wp_enqueue_script( $handle );

[315] Fix | Delete

[316] Fix | Delete

$exported_schema = array();

[317] Fix | Delete

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

[318] Fix | Delete

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

[319] Fix | Delete

}

[320] Fix | Delete

wp_add_inline_script(

[321] Fix | Delete

$handle,

[322] Fix | Delete

sprintf(

[323] Fix | Delete

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

[324] Fix | Delete

wp_json_encode( $this->id_base ),

[325] Fix | Delete

wp_json_encode( $exported_schema )

[326] Fix | Delete

)

[327] Fix | Delete

);

[328] Fix | Delete

[329] Fix | Delete

wp_add_inline_script(

[330] Fix | Delete

$handle,

[331] Fix | Delete

sprintf(

[332] Fix | Delete

[333] Fix | Delete

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

[334] Fix | Delete

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

[335] Fix | Delete

[336] Fix | Delete

wp_json_encode( $this->id_base ),

[337] Fix | Delete

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

[338] Fix | Delete

wp_json_encode( $this->l10n )

[339] Fix | Delete

)

[340] Fix | Delete

);

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

/**

[344] Fix | Delete

* Render form template scripts.

[345] Fix | Delete

[346] Fix | Delete

* @since 4.8.0

[347] Fix | Delete

[348] Fix | Delete

public function render_control_template_scripts() {

[349] Fix | Delete

parent::render_control_template_scripts();

[350] Fix | Delete

[351] Fix | Delete

[352] Fix | Delete

[353] Fix | Delete

<# var elementIdPrefix = 'el' + String( Math.random() ) + '_'; #>

[354] Fix | Delete

<# if ( data.url ) { #>

[355] Fix | Delete

[356] Fix | Delete

[357] Fix | Delete

[358] Fix | Delete

</p>

[359] Fix | Delete

<# } #>

[360] Fix | Delete

</script>

[361] Fix | Delete

[362] Fix | Delete

<# if ( data.error && 'missing_attachment' === data.error ) { #>

[363] Fix | Delete

<?php

[364] Fix | Delete

wp_admin_notice(

[365] Fix | Delete

$this->l10n['missing_attachment'],

[366] Fix | Delete

array(

[367] Fix | Delete

'type' => 'error',

[368] Fix | Delete

'additional_classes' => array( 'notice-alt', 'notice-missing-attachment' ),

[369] Fix | Delete

)

[370] Fix | Delete

);

[371] Fix | Delete

[372] Fix | Delete

<# } else if ( data.error ) { #>

[373] Fix | Delete

<?php

[374] Fix | Delete

wp_admin_notice(

[375] Fix | Delete

__( 'Unable to preview media due to an unknown error.' ),

[376] Fix | Delete

array(

[377] Fix | Delete

'type' => 'error',

[378] Fix | Delete

'additional_classes' => array( 'notice-alt' ),

[379] Fix | Delete

)

[380] Fix | Delete

);

[381] Fix | Delete

[382] Fix | Delete

<# } else if ( data.url ) { #>

[383] Fix | Delete

<img class="attachment-thumb" src="{{ data.url }}" draggable="false" alt="{{ data.alt }}"

[384] Fix | Delete

<# if ( ! data.alt && data.currentFilename ) { #>

[385] Fix | Delete

aria-label="

[386] Fix | Delete

<?php

[387] Fix | Delete

echo esc_attr(

[388] Fix | Delete

sprintf(

[389] Fix | Delete

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

[390] Fix | Delete

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

[391] Fix | Delete

'{{ data.currentFilename }}'

[392] Fix | Delete

)

[393] Fix | Delete

);

[394] Fix | Delete

[395] Fix | Delete

[396] Fix | Delete

<# } #>

[397] Fix | Delete

[398] Fix | Delete

<# } #>

[399] Fix | Delete

</script>

[400] Fix | Delete

<?php

[401] Fix | Delete

}

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete