WordPress.org

Make WordPress Core

Ticket #32417: 32417.16.diff

File 32417.16.diff, 27.3 KB (added by gonom9, 9 months ago)

Fix: Changing title and caption of the image don't reflect in the widget

  • src/wp-admin/css/customize-widgets.css

    diff --git a/src/wp-admin/css/customize-widgets.css b/src/wp-admin/css/customize-widgets.css
    index 687c9f8..c859240 100644
    a b body.adding-widget #customize-preview { 
    346346#available-widgets [class*="event"] .widget-title:before, 
    347347#available-widgets [class*="calendar"] .widget-title:before { content: "\f145"; top: -4px;} 
    348348 
     349/* media */ 
     350#available-widgets [class*="media"] .widget-title:before { 
     351        content: "\f104"; 
     352} 
     353 
    349354/* format-image */ 
    350355#available-widgets [class*="image"] .widget-title:before, 
    351356#available-widgets [class*="photo"] .widget-title:before, 
  • src/wp-includes/class-wp-customize-manager.php

    diff --git a/src/wp-includes/class-wp-customize-manager.php b/src/wp-includes/class-wp-customize-manager.php
    index 229a248..e913d7a 100644
    a b final class WP_Customize_Manager { 
    18071807                                'stylesheet' => $this->get_stylesheet(), 
    18081808                                'active'     => $this->is_theme_active(), 
    18091809                        ), 
     1810                        'media' => array( 
     1811                                /** This filter is documented in wp-includes/media.php */ 
     1812                                'audioLibrary' => apply_filters( 'wp_audio_shortcode_library', 'mediaelement' ), 
     1813                                /** This filter is documented in wp-includes/media.php */ 
     1814                                'videoLibrary' => apply_filters( 'wp_video_shortcode_library', 'mediaelement' ), 
     1815                        ), 
    18101816                        'url' => array( 
    18111817                                'self' => $self_url, 
    18121818                                'allowed' => array_map( 'esc_url_raw', $this->get_allowed_urls() ), 
  • new file src/wp-includes/css/wp-media-widget.css

    diff --git a/src/wp-includes/css/wp-media-widget.css b/src/wp-includes/css/wp-media-widget.css
    new file mode 100644
    index 0000000..d36ec25
    - +  
     1.media-widget-preview .button { 
     2        text-align: center 
     3} 
     4 
     5.media-widget-preview .wp-caption { 
     6        max-width: 100%; 
     7        margin: 0; 
     8} 
     9 
     10.media-widget-preview .image { 
     11        height: auto; 
     12        max-width: 100%; 
     13        cursor: pointer; 
     14} 
     15 
     16.media-widget-preview .aligncenter { 
     17        display: block; 
     18        margin: 0 auto; 
     19        text-align: center 
     20} 
  • src/wp-includes/default-widgets.php

    diff --git a/src/wp-includes/default-widgets.php b/src/wp-includes/default-widgets.php
    index 0cf5fc3..e803135 100644
    a b require_once( ABSPATH . WPINC . '/widgets/class-wp-widget-tag-cloud.php' ); 
    4545 
    4646/** WP_Nav_Menu_Widget class */ 
    4747require_once( ABSPATH . WPINC . '/widgets/class-wp-nav-menu-widget.php' ); 
     48 
     49/** WP_Widget_Media class */ 
     50require_once( ABSPATH . WPINC . '/widgets/class-wp-widget-media.php' ); 
  • src/wp-includes/js/customize-selective-refresh.js

    diff --git a/src/wp-includes/js/customize-selective-refresh.js b/src/wp-includes/js/customize-selective-refresh.js
    index 4f71656..51c69ee 100644
    a b wp.customize.selectiveRefresh = ( function( $, api ) { 
    398398                 * @returns {boolean} Whether the rendering was successful and the fallback was not invoked. 
    399399                 */ 
    400400                renderContent: function( placement ) { 
    401                         var partial = this, content, newContainerElement; 
     401                        var partial = this, content, mediaSettings = api.settings.media, newContainerElement; 
    402402                        if ( ! placement.container ) { 
    403403                                partial.fallback( new Error( 'no_container' ), [ placement ] ); 
    404404                                return false; 
    wp.customize.selectiveRefresh = ( function( $, api ) { 
    452452                                        placement.container.html( content ); 
    453453                                } 
    454454 
     455                                // Auto-initialize media elements when they are contained in the placement 
     456                                if ( $( 'audio, video', placement.container ).length > 0 ) { 
     457                                        if ( wp.mediaelement && wp.mediaelement.initialize && _.contains( [ mediaSettings.audioLibrary, mediaSettings.videoLibrary ], 'mediaelement' ) ) { 
     458                                                wp.mediaelement.initialize(); 
     459                                        } 
     460                                } 
     461 
    455462                                placement.container.removeClass( 'customize-render-content-error' ); 
    456463                        } catch ( error ) { 
    457464                                if ( 'undefined' !== typeof console && console.error ) { 
  • new file src/wp-includes/js/wp-media-widget.js

    diff --git a/src/wp-includes/js/wp-media-widget.js b/src/wp-includes/js/wp-media-widget.js
    new file mode 100644
    index 0000000..a86286a
    - +  
     1/** 
     2 * @since 4.8.0 
     3 * 
     4 * @package WP_Media_Widget 
     5 */ 
     6( function( $, l10n ) { 
     7        'use strict'; 
     8 
     9        var frame = { 
     10                defaultProps: { 
     11                        id:      '', 
     12                        align:   '', 
     13                        size:    '', 
     14                        link:    '', 
     15                        caption: '', 
     16                        'attachment-title': '' 
     17                }, 
     18 
     19                /** 
     20                 * Init. 
     21                 * 
     22                 * @returns {void} 
     23                 */ 
     24                init: function() { 
     25                        frame.bindEvent(); 
     26                        wp.mediaelement.initialize(); 
     27                }, 
     28 
     29                /** 
     30                 * Bind event. 
     31                 * 
     32                 * @param {jQuery} context Element. 
     33                 * @returns {void} 
     34                 */ 
     35                bindEvent: function( context ) { 
     36                        $( '.button.select-media, .image', context || '.media-widget-preview' ) 
     37                                .off( 'click.mediaWidget' ) 
     38                                .on( 'click.mediaWidget', frame.openMediaManager ); 
     39                }, 
     40 
     41                /** 
     42                 * Get current selection of media. 
     43                 * 
     44                 * @param {String} widgetId Widget ID. 
     45                 * @returns {wp.media.models.Selection|null} Selection or null if no current selection. 
     46                 */ 
     47                getSelection: function( widgetId ) { 
     48                        var ids, selection; 
     49                        ids = $( '#widget-' + widgetId + '-id' ).val(); 
     50 
     51                        if ( ! ids ) { 
     52                                return null; 
     53                        } 
     54 
     55                        selection = ids.split( ',' ).reduce( function( list, id ) { 
     56                                var attachment = wp.media.attachment( id ); 
     57                                if ( id && attachment ) { 
     58                                        list.push( attachment ); 
     59                                } 
     60                                return list; 
     61                        }, [] ); 
     62 
     63                        return new wp.media.model.Selection( selection ); 
     64                }, 
     65 
     66                /** 
     67                 * Open media manager. 
     68                 * 
     69                 * @param {jQuery.Event} event Event. 
     70                 * @returns {void} 
     71                 */ 
     72                openMediaManager: function( event ) { 
     73                        var widgetFrame, widgetId; 
     74                        widgetId = $( event.target ).data( 'id' ); 
     75 
     76                        // Create the media frame. 
     77                        widgetFrame = wp.media( { 
     78                                button: { 
     79                                        text: translate( 'addToWidget', 'Add to widget' ) // Text of the submit button. 
     80                                }, 
     81 
     82                                states: new wp.media.controller.Library( { 
     83                                        library:    wp.media.query( { type: [ 'image', 'audio', 'video' ] } ), 
     84                                        title:      translate( 'selectMedia', 'Select Media' ), // Media frame title 
     85                                        selection:  frame.getSelection( widgetId ), 
     86                                        multiple:   false, 
     87                                        priority:   20, 
     88                                        display:    true, // Attachment display setting 
     89                                        filterable: 'all' 
     90                                } ) 
     91                        } ); 
     92 
     93                        // Render the attachment details. 
     94                        widgetFrame.on( 'select', function() { 
     95                                var props, attachment; 
     96 
     97                                // Only try to render the attachment details if a selection was made. 
     98                                if ( widgetFrame.state().get( 'selection' ).length > 0 ) { 
     99                                        props = widgetFrame.content.get( '.attachments-browser' ) 
     100                                                .sidebar.get( 'display' ).model.toJSON(); 
     101 
     102                                        attachment = widgetFrame.state().get( 'selection' ).first().toJSON(); 
     103 
     104                                        frame.renderFormView( widgetId, props, attachment ); 
     105                                } 
     106                        } ); 
     107 
     108                        widgetFrame.open( widgetId ); 
     109                }, 
     110 
     111                /** 
     112                 * Renders the attachment details from the media modal into the widget. 
     113                 * 
     114                 * @param {String} widgetId Widget ID. 
     115                 * @param {Object} props Attachment Display Settings (align, link, size, etc). 
     116                 * @param {Object} attachment Attachment Details (title, description, caption, url, sizes, etc). 
     117                 * @returns {void} 
     118                 */ 
     119                renderFormView: function( widgetId, props, attachment ) { 
     120                        // Start with container elements for the widgets page, customizer controls, and customizer preview. 
     121                        var formView = $( '.' + widgetId + ', #customize-control-widget_' + widgetId + ', #' + widgetId ); 
     122 
     123                        // Bail if there is no target form 
     124                        if ( ! formView.length ) { 
     125                                return; 
     126                        } 
     127 
     128                        _.extend( attachment, _.pick( props, 'link', 'size' ) ); 
     129                        attachment['attachment-title'] = attachment['title']; 
     130 
     131                        // Show/hide the widget description 
     132                        formView.find( '.attachment-description' ) 
     133                                .toggleClass( 'hidden', ! attachment.description ) 
     134                                .html( attachment.description ); 
     135 
     136                        // Display a preview of the image in the widgets page and customizer controls. 
     137                        formView.find( '.extras' ).removeClass( 'hidden' ); 
     138 
     139                        // Set the preview content and apply responsive styles to the media. 
     140                        formView.find( '.media-widget-admin-preview' ) 
     141                                .html( frame.renderMediaElement( widgetId, props, attachment ) ) 
     142                                .find( '.wp-video, .wp-caption' ).css( 'width', '100%' ).end() 
     143                                .find( 'img.image' ).css( { width: '100%', height: 'auto' } ); 
     144 
     145                        if ( _.contains( [ 'audio', 'video' ], attachment.type ) ) { 
     146                                wp.mediaelement.initialize(); 
     147                        } 
     148 
     149                        frame.bindEvent( formView ); 
     150 
     151                        // Populate form fields with selection data from the media frame. 
     152                        _.each( _.keys( frame.defaultProps ), function( key ) { 
     153                                formView.find( '#widget-' + widgetId + '-' + key ).val( attachment[ key ] || props[ key ] ).trigger( 'change' ); 
     154                        } ); 
     155 
     156                        // Change button text 
     157                        formView.find( frame.buttonId ).text( translate( 'changeMedia', 'Change Media' ) ); 
     158                }, 
     159 
     160                /** 
     161                 * Renders the media attachment in HTML. 
     162                 * 
     163                 * @param {String} widgetId Widget ID. 
     164                 * @param {Object} props Attachment Display Settings (align, link, size, etc). 
     165                 * @param {Object} attachment Attachment Details (title, description, caption, url, sizes, etc). 
     166                 * 
     167                 * @returns {String} Render media element. 
     168                 */ 
     169                renderMediaElement: function( widgetId, props, attachment ) { 
     170                        var type, renderer; 
     171                        type = attachment.type || ''; 
     172                        renderer = 'render' + type.charAt( 0 ).toUpperCase() + type.slice( 1 ); 
     173 
     174                        if ( 'function' === typeof frame[ renderer ] ) { 
     175                                return frame[renderer]( widgetId, props, attachment ); 
     176                        } 
     177 
     178                        // In case no renderer found 
     179                        return ''; 
     180                }, 
     181 
     182                /** 
     183                 * Renders the image attachment 
     184                 * 
     185                 * @param {String} widgetId Widget ID. 
     186                 * @param {Object} props Attachment Display Settings (align, link, size, etc). 
     187                 * @param {Object} attachment Attachment Details (title, description, caption, url, sizes, etc). 
     188                 * 
     189                 * @returns {String} Rendered image. 
     190                 */ 
     191                renderImage: function( widgetId, props, attachment ) { 
     192                        var image = $( '<img />' ) 
     193                                .addClass( 'image wp-image' + attachment.id ) 
     194                                .attr( { 
     195                                        'data-id': widgetId, 
     196                                        src:       attachment.sizes[ props.size ].url, 
     197                                        title:     attachment.title, 
     198                                        alt:       attachment.alt, 
     199                                        width:     attachment.sizes[ props.size ].width, 
     200                                        height:    attachment.sizes[ props.size ].height 
     201                                } ); 
     202 
     203                        if ( attachment.caption ) { 
     204                                image = $( '<figure />' ) 
     205                                        .width( attachment.sizes[ props.size ].width ) 
     206                                        .addClass( 'wp-caption' ) 
     207                                        .attr( 'id', widgetId + '-caption' ) 
     208                                        .append( image ); 
     209 
     210                                $( '<figcaption class="wp-caption-text" />' ).text( attachment.caption ).appendTo( image ); 
     211                        } 
     212 
     213                        return image.wrap( '<div />' ).parent().html(); 
     214                }, 
     215 
     216                /** 
     217                 * Renders the audio attachment. 
     218                 * 
     219                 * @param {String} widgetId Widget ID. 
     220                 * @param {Object} props Attachment Display Settings (align, link, size, etc). 
     221                 * @param {Object} attachment Attachment Details (title, description, caption, url, sizes, etc). 
     222                 * 
     223                 * @returns {String} Rendered audio. 
     224                 */ 
     225                renderAudio: function( widgetId, props, attachment ) { 
     226                        if ( 'embed' === props.link ) { 
     227                                return wp.media.template( 'wp-media-widget-audio' )( { 
     228                                        model: { 
     229                                                src:    attachment.url 
     230                                        } 
     231                                } ); 
     232                        } 
     233 
     234                        return wp.html.string( { 
     235                                tag: 'a', 
     236                                content: attachment.title, 
     237                                attrs: { 
     238                                        href: '#' 
     239                                } 
     240                        } ); 
     241                }, 
     242 
     243                /** 
     244                 * Renders the video attachment. 
     245                 * 
     246                 * @param {String} widgetId Widget ID. 
     247                 * @param {Object} props Attachment Display Settings (align, link, size, etc). 
     248                 * @param {Object} attachment Attachment Details (title, description, caption, url, sizes, etc). 
     249                 * 
     250                 * @returns {String} Rendered video. 
     251                 */ 
     252                renderVideo: function( widgetId, props, attachment ) { 
     253                        if ( 'embed' === props.link ) { 
     254                                return wp.media.template( 'wp-media-widget-video' )( { 
     255                                        model: { 
     256                                                src:    attachment.url, 
     257                                                width:  attachment.width, 
     258                                                height: attachment.height 
     259                                        } 
     260                                } ); 
     261                        } 
     262 
     263                        return wp.html.string( { 
     264                                tag: 'a', 
     265                                content: attachment.title, 
     266                                attrs: { 
     267                                        href: '#' 
     268                                } 
     269                        } ); 
     270                } 
     271        }; 
     272 
     273        /** 
     274         * Translate. 
     275         * 
     276         * @param {string} key Key. 
     277         * @param {string} defaultText Default text. 
     278         * @return {string} Translated string. 
     279         */ 
     280        function translate( key, defaultText ) { 
     281                return l10n[ key ] || defaultText; 
     282        } 
     283 
     284        $( document ) 
     285                .ready( frame.init ) 
     286                .on( 'widget-added widget-updated', frame.init ); 
     287 
     288        window.wp = window.wp || {}; 
     289        window.wp.MediaWidget = frame; 
     290} )( jQuery, window._mediaWidgetL10n || {} ); 
  • src/wp-includes/script-loader.php

    diff --git a/src/wp-includes/script-loader.php b/src/wp-includes/script-loader.php
    index b2e24d6..8cbddef 100644
    a b function wp_default_scripts( &$scripts ) { 
    761761                $scripts->add( 'media-gallery', "/wp-admin/js/media-gallery$suffix.js", array('jquery'), false, 1 ); 
    762762 
    763763                $scripts->add( 'svg-painter', '/wp-admin/js/svg-painter.js', array( 'jquery' ), false, 1 ); 
     764 
     765                // Media Widget. 
     766                $scripts->add( 'wp-media-widget', '/wp-includes/js/wp-media-widget.js', array( 'jquery', 'media-models', 'media-views' ), false, 1 ); 
     767                did_action( 'init' ) && $scripts->localize( 'wp-media-widget', '_mediaWidgetL10n', array( 
     768                        'selectMedia' => __( 'Select Media' ), 
     769                        'changeMedia' => __( 'Change Media' ), 
     770                        'addToWidget' => __( 'Add to widget' ), 
     771                ) ); 
    764772        } 
    765773} 
    766774 
    function wp_default_styles( &$styles ) { 
    865873        $styles->add( 'media-views',          "/wp-includes/css/media-views$suffix.css", array( 'buttons', 'dashicons', 'wp-mediaelement' ) ); 
    866874        $styles->add( 'wp-pointer',           "/wp-includes/css/wp-pointer$suffix.css", array( 'dashicons' ) ); 
    867875        $styles->add( 'customize-preview',    "/wp-includes/css/customize-preview$suffix.css", array( 'dashicons' ) ); 
     876        $styles->add( 'wp-media-widget',      "/wp-includes/css/wp-media-widget$suffix.css", array( 'media-views' ) ); 
    868877        $styles->add( 'wp-embed-template-ie', "/wp-includes/css/wp-embed-template-ie$suffix.css" ); 
    869878        $styles->add_data( 'wp-embed-template-ie', 'conditional', 'lte IE 8' ); 
    870879 
  • src/wp-includes/widgets.php

    diff --git a/src/wp-includes/widgets.php b/src/wp-includes/widgets.php
    index 1abadfb..ad36710 100644
    a b function wp_widgets_init() { 
    14661466 
    14671467        register_widget('WP_Nav_Menu_Widget'); 
    14681468 
     1469        register_widget('WP_Widget_Media'); 
     1470 
    14691471        /** 
    14701472         * Fires after all default WordPress widgets have been registered. 
    14711473         * 
  • new file src/wp-includes/widgets/class-wp-widget-media.php

    diff --git a/src/wp-includes/widgets/class-wp-widget-media.php b/src/wp-includes/widgets/class-wp-widget-media.php
    new file mode 100644
    index 0000000..519a703
    - +  
     1<?php 
     2/** 
     3 * Widget API: WP_Media_Widget class 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Widgets 
     7 * @since 4.8.0 
     8 */ 
     9 
     10/** 
     11 * Core class that implements a media widget. 
     12 * 
     13 * @since 4.8.0 
     14 * 
     15 * @see WP_Widget 
     16 */ 
     17class WP_Widget_Media extends WP_Widget { 
     18 
     19        /** 
     20         * Default instance. 
     21         * 
     22         * @var array 
     23         */ 
     24        private $default_instance = array( 
     25                'id'          => '', 
     26                'title'       => '', 
     27                'link'        => '', 
     28                'align'       => 'none', 
     29        ); 
     30 
     31        /** 
     32         * Constructor. 
     33         * 
     34         * @since 4.8.0 
     35         * @access public 
     36         * 
     37         * @param string $id_base         Optional Base ID for the widget, lowercase and unique. If left empty, 
     38         *                                a portion of the widget's class name will be used Has to be unique. 
     39         * @param string $name            Optional. Name for the widget displayed on the configuration page. 
     40         *                                Default empty. 
     41         * @param array  $widget_options  Optional. Widget options. See wp_register_sidebar_widget() for 
     42         *                                information on accepted arguments. Default empty array. 
     43         * @param array  $control_options Optional. Widget control options. See wp_register_widget_control() 
     44         *                                for information on accepted arguments. Default empty array. 
     45         */ 
     46        public function __construct( $id_base = '', $name = '', $widget_options = array(), $control_options = array() ) { 
     47                $widget_opts = wp_parse_args( $widget_options, array( 
     48                        'classname' => 'widget_media', 
     49                        'description' => __( 'An image, video, or audio file.' ), 
     50                        'customize_selective_refresh' => true, 
     51                ) ); 
     52 
     53                $control_opts = wp_parse_args( $control_options, array() ); 
     54 
     55                parent::__construct( 
     56                        $id_base ? $id_base : 'wp-media-widget', // @todo This should just be 'media'. 
     57                        $name ? $name : __( 'Media' ), 
     58                        $widget_opts, 
     59                        $control_opts 
     60                ); 
     61 
     62                if ( is_customize_preview() ) { 
     63                        $this->enqueue_mediaelement_script(); 
     64                } 
     65 
     66                add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); 
     67                add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); 
     68        } 
     69 
     70        /** 
     71         * Displays the widget on the front-end. 
     72         * 
     73         * @since 4.8.0 
     74         * @access public 
     75         * 
     76         * @see WP_Widget::widget() 
     77         * 
     78         * @param array $args     Display arguments including before_title, after_title, before_widget, and after_widget. 
     79         * @param array $instance Saved setting from the database. 
     80         */ 
     81        public function widget( $args, $instance ) { 
     82                $output = $args['before_widget']; 
     83 
     84                $instance = array_merge( $this->default_instance, $instance ); 
     85 
     86                if ( $instance['title'] ) { 
     87                        $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base ); 
     88                        $output .= $args['before_title'] . $title . $args['after_title']; 
     89                } 
     90 
     91                // Render the media. 
     92                $attachment = $instance['id'] ? get_post( $instance['id'] ) : null; 
     93                if ( $attachment ) { 
     94                        $output .= $this->render_media( $attachment, $args['widget_id'], $instance ); 
     95                        $output .= $this->get_responsive_style( $attachment, $args['widget_id'], $instance ); 
     96                } 
     97 
     98                $output .= $args['after_widget']; 
     99 
     100                echo $output; 
     101        } 
     102 
     103        /** 
     104         * Sanitizes the widget form values as they are saved. 
     105         * 
     106         * @since 4.8.0 
     107         * @access public 
     108         * 
     109         * @see WP_Widget::update() 
     110         * 
     111         * @param array $new_instance Values just sent to be saved. 
     112         * @param array $old_instance Previously saved values from database. 
     113         * @return array Updated safe values to be saved. 
     114         */ 
     115        public function update( $new_instance, $old_instance ) { 
     116                $instance = $old_instance; 
     117 
     118                // ID and title. 
     119                $instance['id']    = (int) $new_instance['id']; 
     120                $instance['title'] = sanitize_text_field( $new_instance['title'] ); 
     121 
     122                // Everything else. 
     123                $instance['align']   = sanitize_text_field( $new_instance['align'] ); 
     124                $instance['size']    = sanitize_text_field( $new_instance['size'] ); 
     125                $instance['link']    = sanitize_text_field( $new_instance['link'] ); 
     126                $instance['caption'] = sanitize_text_field( $new_instance['caption'] ); 
     127                $instance['attachment-title'] = sanitize_text_field( $new_instance['attachment-title'] ); 
     128 
     129                return $instance; 
     130        } 
     131 
     132        /** 
     133         * Get type of a media attachment 
     134         * 
     135         * @since 4.8.0 
     136         * @access private 
     137         * @todo Why private? What about plugins that extend? Should they be able to easily call the parent method? 
     138         * 
     139         * @param WP_Post $attachment Attachment object. 
     140         * @return String type string such as image, audio and video. Returns empty string for unknown type 
     141         */ 
     142        private function get_typeof_media( $attachment ) { 
     143                if ( wp_attachment_is_image( $attachment ) ) { 
     144                        return 'image'; 
     145                } 
     146 
     147                if ( wp_attachment_is( 'audio', $attachment ) ) { 
     148                        return 'audio'; 
     149                } 
     150 
     151                if ( wp_attachment_is( 'video', $attachment ) ) { 
     152                        return 'video'; 
     153                } 
     154 
     155                // Unknown media type. 
     156                return ''; 
     157        } 
     158 
     159        /** 
     160         * Renders a single media attachment 
     161         * 
     162         * @since 4.8.0 
     163         * @access public 
     164         * 
     165         * @param WP_Post $attachment Attachment object. 
     166         * @param string  $widget_id  Widget ID. 
     167         * @param array   $instance   Current widget instance arguments. 
     168         * @return string 
     169         */ 
     170        public function render_media( $attachment, $widget_id, $instance ) { 
     171                $output = ''; 
     172                $renderer = 'render_' . $this->get_typeof_media( $attachment ); 
     173 
     174                if ( method_exists( $this, $renderer ) ) { 
     175                        $output .= call_user_func( array( $this, $renderer ), $attachment, $widget_id, $instance ); 
     176                } 
     177 
     178                return $output; 
     179        } 
     180 
     181        /** 
     182         * Renders an image attachment preview. 
     183         * 
     184         * @since 4.8.0 
     185         * @access private 
     186         * 
     187         * @param WP_Post $attachment Attachment object. 
     188         * @param string  $widget_id  Widget ID. 
     189         * @param array   $instance   Current widget instance arguments. 
     190         * @return string 
     191         */ 
     192        private function render_image( $attachment, $widget_id, $instance ) { 
     193                $has_caption   = ( ! empty( $attachment->post_excerpt ) ); 
     194 
     195                $img_attrs = array( 
     196                        'data-id' => $widget_id, 
     197                        'title'   => $attachment->post_title, 
     198                        'class'   => 'image wp-image-' . $attachment->ID, 
     199                        'style'   => 'width: 100%; height: auto;', 
     200                ); 
     201 
     202                if ( ! $has_caption ) { 
     203                        $img_attrs['class'] .= ' align' . $instance['align']; 
     204                } 
     205 
     206                $image = wp_get_attachment_image( $attachment->ID, $instance['size'], false, $img_attrs ); 
     207 
     208                if ( ! $has_caption ) { 
     209                        return $image; 
     210                } 
     211 
     212                $fig_attrs = array( 
     213                        'id'      => $widget_id . '-caption', 
     214                        'width'   => get_option( $instance['size'] . '_size_w' ), 
     215                        'align'   => $instance['align'], 
     216                        'caption' => $attachment->post_excerpt, 
     217                ); 
     218 
     219                $figure = img_caption_shortcode( $fig_attrs, $image ); 
     220 
     221                return $figure; 
     222        } 
     223 
     224        /** 
     225         * Renders an audio attachment preview. 
     226         * 
     227         * @since 4.8.0 
     228         * @access private 
     229         * 
     230         * @param WP_Post $attachment Attachment object. 
     231         * @param string  $widget_id  Widget ID. 
     232         * @param array   $instance   Current widget instance arguments. 
     233         * @return string 
     234         */ 
     235        private function render_audio( $attachment, $widget_id, $instance ) { 
     236                unset( $widget_id ); 
     237                if ( in_array( $instance['link'], array( 'file', 'post' ), true ) ) { 
     238                        return $this->create_link_for( $attachment, $instance['link'] ); 
     239                } 
     240 
     241                return wp_audio_shortcode( array( 
     242                        'src' => wp_get_attachment_url( $attachment->ID ), 
     243                ) ); 
     244        } 
     245 
     246        /** 
     247         * Renders a video attachment preview. 
     248         * 
     249         * @since 4.8.0 
     250         * @access private 
     251         * 
     252         * @param WP_Post $attachment Attachment object. 
     253         * @param string  $widget_id  Widget ID. 
     254         * @param array   $instance   Current widget instance arguments. 
     255         * @return string 
     256         */ 
     257        private function render_video( $attachment, $widget_id, $instance ) { 
     258                unset( $widget_id ); 
     259                if ( in_array( $instance['link'], array( 'file', 'post' ), true ) ) { 
     260                        return $this->create_link_for( $attachment, $instance['link'] ); 
     261                } 
     262 
     263                return wp_video_shortcode( array( 
     264                        'src' => wp_get_attachment_url( $attachment->ID ), 
     265                ) ); 
     266        } 
     267 
     268        /** 
     269         * Get styles for responsifying the widget 
     270         * 
     271         * @since 4.8.0 
     272         * @access private 
     273         * 
     274         * @param WP_Post $attachment Attachment object. 
     275         * @param string  $widget_id  Widget ID. 
     276         * @return string styles for responsive media 
     277         */ 
     278        private function get_responsive_style( $attachment, $widget_id ) { 
     279                if ( wp_attachment_is( 'audio', $attachment ) ) { 
     280                        return; 
     281                } 
     282 
     283                $output = '<style type="text/css">'; 
     284 
     285                if ( wp_attachment_is_image( $attachment ) ) { 
     286                        $output .= "#{$widget_id}-caption{ width: 100% !important; }"; 
     287                } 
     288 
     289                if ( wp_attachment_is( 'video', $attachment ) ) { 
     290                        $output .= "#{$widget_id} .wp-video{ width: 100% !important; }"; 
     291                } 
     292 
     293                $output .= '</style>'; 
     294 
     295                return $output; 
     296        } 
     297 
     298 
     299        /** 
     300         * Creates and returns a link for an attachment 
     301         * 
     302         * @param WP_Post $attachment Attachment object. 
     303         * @param string  $type       link type. 
     304         * @return string 
     305         */ 
     306        private function create_link_for( $attachment, $type = '' ) { 
     307                $url = '#'; 
     308                if ( 'file' === $type ) { 
     309                        $url = wp_get_attachment_url( $attachment->ID ); 
     310                } elseif ( 'post' === $type ) { 
     311                        $url = get_attachment_link( $attachment->ID ); 
     312                } 
     313 
     314                return '<a href="' . esc_url( $url ) . '">' . $attachment->post_title . '</a>'; 
     315        } 
     316 
     317        /** 
     318         * Outputs the settings update form. 
     319         * 
     320         * @since 4.8.0 
     321         * @access public 
     322         * 
     323         * @param array $saved_instance Current settings. 
     324         * @return void 
     325         */ 
     326        public function form( $saved_instance ) { 
     327                $defaults = array( 
     328                        'title'   => '', 
     329                        // Attachment props. 
     330                        'id'      => '', 
     331                        'align'   => '', 
     332                        'size'    => '', 
     333                        'link'    => '', 
     334                        'caption' => '', 
     335                        'attachment-title' => '', 
     336                ); 
     337 
     338                $instance   = wp_parse_args( (array) $saved_instance, $defaults ); 
     339                $attachment = empty( $instance['id'] ) ? null : get_post( $instance['id'] ); 
     340                $widget_id  = $this->id; 
     341                ?> 
     342                <div class="<?php echo esc_attr( $widget_id ); ?> media-widget-preview"> 
     343                        <p> 
     344                                <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php esc_html_e( 'Title:' ); ?></label> 
     345                                <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" /> 
     346                        </p> 
     347 
     348                        <p> 
     349                                <?php esc_html_e( 'Add an image, video, or audio to your sidebar.' ); ?> 
     350                        </p> 
     351 
     352                        <div class="media-widget-admin-preview" id="<?php echo esc_attr( $widget_id ); ?>"> 
     353                        <?php 
     354                        if ( $attachment ) { 
     355                                echo $this->render_media( $attachment, $widget_id, $instance ); 
     356                                echo $this->get_responsive_style( $attachment, $widget_id, $instance ); 
     357                        } 
     358                        ?> 
     359                        </div> 
     360 
     361                        <p class="extras"></p> 
     362 
     363                        <p> 
     364                                <button type="button" data-id="<?php echo esc_attr( $widget_id ); ?>" class="button select-media widefat"> 
     365                                        <?php $attachment ? esc_html_e( 'Change Media' ) : esc_html_e( 'Select Media' ); ?> 
     366                                </button> 
     367                        </p> 
     368 
     369                        <?php 
     370                        // Use hidden form fields to capture the attachment details from the media manager. 
     371                        unset( $instance['title'] ); 
     372                        ?> 
     373 
     374                        <?php foreach ( $instance as $name => $value ) : ?> 
     375                                <input type="hidden" id="<?php echo esc_attr( $this->get_field_id( $name ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( $name ) ); ?>" value="<?php echo esc_attr( $value ); ?>" /> 
     376                        <?php endforeach; ?> 
     377                </div> 
     378                <?php 
     379        } 
     380 
     381        /** 
     382         * Registers the stylesheet for handling the widget in the back-end. 
     383         * 
     384         * @since 4.8.0 
     385         * @access public 
     386         */ 
     387        public function enqueue_admin_styles() { 
     388                wp_enqueue_style( 'wp-media-widget' ); 
     389        } 
     390 
     391        /** 
     392         * Registers the scripts for handling the widget in the back-end. 
     393         * 
     394         * @since 4.8.0 
     395         * @access public 
     396         */ 
     397        public function enqueue_admin_scripts() { 
     398                global $pagenow; 
     399 
     400                // Bail if we are not in the widgets or customize screens. 
     401                if ( 'widgets.php' !== $pagenow && ! is_customize_preview() ) { 
     402                        return; 
     403                } 
     404 
     405                // Load the required media files for the media manager. 
     406                wp_enqueue_media(); 
     407 
     408                wp_enqueue_script( 'wp-media-widget' ); 
     409 
     410                add_action( 'admin_print_footer_scripts', array( $this, 'admin_print_footer_scripts' ) ); 
     411        } 
     412 
     413        /** 
     414         * Prints footer scripts. 
     415         * 
     416         * @since 4.8.0 
     417         * @access public 
     418         */ 
     419        public function admin_print_footer_scripts() { 
     420                ?> 
     421                <script type="text/html" id="tmpl-wp-media-widget-audio"> 
     422                <?php wp_underscore_audio_template() ?> 
     423                </script> 
     424 
     425                <script type="text/html" id="tmpl-wp-media-widget-video"> 
     426                <?php wp_underscore_video_template() ?> 
     427                </script> 
     428 
     429                <?php 
     430        } 
     431 
     432        /** 
     433         * Enqueue media element script and style if in need. 
     434         * 
     435         * This ensures the first instance of the media widget can properly handle media elements. 
     436         * 
     437         * @since 4.8.0 
     438         * @access private 
     439         */ 
     440        private function enqueue_mediaelement_script() { 
     441                /** This filter is documented in wp-includes/media.php */ 
     442                $audio_library = apply_filters( 'wp_audio_shortcode_library', 'mediaelement' ); 
     443 
     444                /** This filter is documented in wp-includes/media.php */ 
     445                $video_library = apply_filters( 'wp_video_shortcode_library', 'mediaelement' ); 
     446 
     447                if ( 'mediaelement' !== $audio_library && 'mediaelement' !== $video_library ) { 
     448                        return; 
     449                } 
     450 
     451                wp_enqueue_style( 'wp-mediaelement' ); 
     452                wp_enqueue_script( 'wp-mediaelement' ); 
     453        } 
     454}