WordPress.org

Make WordPress Core

Ticket #32417: 32417.15.diff

File 32417.15.diff, 26.6 KB (added by westonruter, 9 months ago)

Δ https://github.com/xwp/wordpress-develop/pull/215/files/cc2f420..a63e90e

  • src/wp-includes/class-wp-customize-manager.php

    diff --git src/wp-includes/class-wp-customize-manager.php src/wp-includes/class-wp-customize-manager.php
    index 229a2484ba..6468b49205 100644
    final class WP_Customize_Manager { 
    18071807                                'stylesheet' => $this->get_stylesheet(), 
    18081808                                'active'     => $this->is_theme_active(), 
    18091809                        ), 
     1810                        'media' => array( 
     1811                                'audioLibrary' => apply_filters( 'wp_audio_shortcode_library', 'mediaelement' ), 
     1812                                'videoLibrary' => apply_filters( 'wp_video_shortcode_library', 'mediaelement' ), 
     1813                        ), 
    18101814                        'url' => array( 
    18111815                                'self' => $self_url, 
    18121816                                'allowed' => array_map( 'esc_url_raw', $this->get_allowed_urls() ), 
  • new file src/wp-includes/css/wp-media-widget.css

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

    diff --git src/wp-includes/script-loader.php src/wp-includes/script-loader.php
    index b2e24d6fed..8cbddefea2 100644
    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 src/wp-includes/widgets.php src/wp-includes/widgets.php
    index 1abadfb186..ad367102e9 100644
    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 src/wp-includes/widgets/class-wp-widget-media.php src/wp-includes/widgets/class-wp-widget-media.php
    new file mode 100644
    index 0000000000..a5e2b1c95e
    - +  
     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                'description' => '', 
     28                'link'        => '', 
     29                'align'       => 'none', 
     30        ); 
     31 
     32        /** 
     33         * Constructor. 
     34         * 
     35         * @since 4.8.0 
     36         * @access public 
     37         * 
     38         * @param string $id_base         Optional Base ID for the widget, lowercase and unique. If left empty, 
     39         *                                a portion of the widget's class name will be used Has to be unique. 
     40         * @param string $name            Optional. Name for the widget displayed on the configuration page. 
     41         *                                Default empty. 
     42         * @param array  $widget_options  Optional. Widget options. See wp_register_sidebar_widget() for 
     43         *                                information on accepted arguments. Default empty array. 
     44         * @param array  $control_options Optional. Widget control options. See wp_register_widget_control() 
     45         *                                for information on accepted arguments. Default empty array. 
     46         */ 
     47        public function __construct( $id_base = '', $name = '', $widget_options = array(), $control_options = array() ) { 
     48                $widget_opts = wp_parse_args( $widget_options, array( 
     49                        'classname' => 'widget_media', 
     50                        'description' => __( 'Display media such as images, video, or audio in your sidebar.' ), 
     51                        'customize_selective_refresh' => true, 
     52                ) ); 
     53 
     54                $control_opts = wp_parse_args( $control_options, array() ); 
     55 
     56                parent::__construct( 
     57                        $id_base ? $id_base : 'wp-media-widget', // @todo This should just be 'media'. 
     58                        $name ? $name : __( 'Media' ), 
     59                        $widget_opts, 
     60                        $control_opts 
     61                ); 
     62 
     63                if ( is_customize_preview() ) { 
     64                        $this->enqueue_mediaelement_script(); 
     65                } 
     66 
     67                add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) ); 
     68                add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); 
     69        } 
     70 
     71        /** 
     72         * Displays the widget on the front-end. 
     73         * 
     74         * @since 4.8.0 
     75         * @access public 
     76         * 
     77         * @see WP_Widget::widget() 
     78         * 
     79         * @param array $args     Display arguments including before_title, after_title, before_widget, and after_widget. 
     80         * @param array $instance Saved setting from the database. 
     81         */ 
     82        public function widget( $args, $instance ) { 
     83                $output = $args['before_widget']; 
     84 
     85                $instance = array_merge( $this->default_instance, $instance ); 
     86 
     87                if ( $instance['title'] ) { 
     88                        $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base ); 
     89                        $output .= $args['before_title'] . $title . $args['after_title']; 
     90                } 
     91                if ( $instance['description'] ) { 
     92                        $output .= '<p class="attachment-description align' . esc_attr( $instance['align'] ) . '">' . $instance['description'] . '</p>'; 
     93                } 
     94 
     95                // Render the media. 
     96                $attachment = $instance['id'] ? get_post( $instance['id'] ) : null; 
     97                if ( $attachment ) { 
     98                        $output .= $this->render_media( $attachment, $args['widget_id'], $instance ); 
     99                        $output .= $this->get_responsive_style( $attachment, $args['widget_id'], $instance ); 
     100                } 
     101 
     102                $output .= $args['after_widget']; 
     103 
     104                echo $output; 
     105        } 
     106 
     107        /** 
     108         * Sanitizes the widget form values as they are saved. 
     109         * 
     110         * @since 4.8.0 
     111         * @access public 
     112         * 
     113         * @see WP_Widget::update() 
     114         * 
     115         * @param array $new_instance Values just sent to be saved. 
     116         * @param array $old_instance Previously saved values from database. 
     117         * @return array Updated safe values to be saved. 
     118         */ 
     119        public function update( $new_instance, $old_instance ) { 
     120                $instance = $old_instance; 
     121 
     122                // ID and title. 
     123                $instance['id']    = (int) $new_instance['id']; 
     124                $instance['title'] = sanitize_text_field( $new_instance['title'] ); 
     125 
     126                // Everything else. 
     127                $instance['align'] = sanitize_text_field( $new_instance['align'] ); 
     128                $instance['size']  = sanitize_text_field( $new_instance['size'] ); 
     129                $instance['link']  = sanitize_text_field( $new_instance['link'] ); 
     130 
     131                return $instance; 
     132        } 
     133 
     134        /** 
     135         * Get type of a media attachment 
     136         * 
     137         * @since 4.8.0 
     138         * @access private 
     139         * @todo Why private? What about plugins that extend? Should they be able to easily call the parent method? 
     140         * 
     141         * @param WP_Post $attachment Attachment object. 
     142         * @return String type string such as image, audio and video. Returns empty string for unknown type 
     143         */ 
     144        private function get_typeof_media( $attachment ) { 
     145                if ( wp_attachment_is_image( $attachment ) ) { 
     146                        return 'image'; 
     147                } 
     148 
     149                if ( wp_attachment_is( 'audio', $attachment ) ) { 
     150                        return 'audio'; 
     151                } 
     152 
     153                if ( wp_attachment_is( 'video', $attachment ) ) { 
     154                        return 'video'; 
     155                } 
     156 
     157                // Unknown media type. 
     158                return ''; 
     159        } 
     160 
     161        /** 
     162         * Renders a single media attachment 
     163         * 
     164         * @since 4.8.0 
     165         * @access public 
     166         * 
     167         * @param WP_Post $attachment Attachment object. 
     168         * @param string  $widget_id  Widget ID. 
     169         * @param array   $instance   Current widget instance arguments. 
     170         * @return string 
     171         */ 
     172        public function render_media( $attachment, $widget_id, $instance ) { 
     173                $output = ''; 
     174                $renderer = 'render_' . $this->get_typeof_media( $attachment ); 
     175 
     176                if ( method_exists( $this, $renderer ) ) { 
     177                        $output .= call_user_func( array( $this, $renderer ), $attachment, $widget_id, $instance ); 
     178                } 
     179 
     180                return $output; 
     181        } 
     182 
     183        /** 
     184         * Renders an image attachment preview. 
     185         * 
     186         * @since 4.8.0 
     187         * @access private 
     188         * 
     189         * @param WP_Post $attachment Attachment object. 
     190         * @param string  $widget_id  Widget ID. 
     191         * @param array   $instance   Current widget instance arguments. 
     192         * @return string 
     193         */ 
     194        private function render_image( $attachment, $widget_id, $instance ) { 
     195                $has_caption   = ( ! empty( $attachment->post_excerpt ) ); 
     196 
     197                $img_attrs = array( 
     198                        'data-id' => $widget_id, 
     199                        'title'   => $attachment->post_title, 
     200                        'class'   => 'image wp-image-' . $attachment->ID, 
     201                        'style'   => 'width: 100%; height: auto;', 
     202                ); 
     203 
     204                if ( ! $has_caption ) { 
     205                        $img_attrs['class'] .= ' align' . $instance['align']; 
     206                } 
     207 
     208                $image = wp_get_attachment_image( $attachment->ID, $instance['size'], false, $img_attrs ); 
     209 
     210                if ( ! $has_caption ) { 
     211                        return $image; 
     212                } 
     213 
     214                $fig_attrs = array( 
     215                        'id'      => $widget_id . '-caption', 
     216                        'width'   => get_option( $instance['size'] . '_size_w' ), 
     217                        'align'   => $instance['align'], 
     218                        'caption' => $attachment->post_excerpt, 
     219                ); 
     220 
     221                $figure = img_caption_shortcode( $fig_attrs, $image ); 
     222 
     223                return $figure; 
     224        } 
     225 
     226        /** 
     227         * Renders an audio attachment preview. 
     228         * 
     229         * @since 4.8.0 
     230         * @access private 
     231         * 
     232         * @param WP_Post $attachment Attachment object. 
     233         * @param string  $widget_id  Widget ID. 
     234         * @param array   $instance   Current widget instance arguments. 
     235         * @return string 
     236         */ 
     237        private function render_audio( $attachment, $widget_id, $instance ) { 
     238                unset( $widget_id ); 
     239                if ( in_array( $instance['link'], array( 'file', 'post' ), true ) ) { 
     240                        return $this->create_link_for( $attachment, $instance['link'] ); 
     241                } 
     242 
     243                return wp_audio_shortcode( array( 
     244                        'src' => wp_get_attachment_url( $attachment->ID ), 
     245                ) ); 
     246        } 
     247 
     248        /** 
     249         * Renders a video attachment preview. 
     250         * 
     251         * @since 4.8.0 
     252         * @access private 
     253         * 
     254         * @param WP_Post $attachment Attachment object. 
     255         * @param string  $widget_id  Widget ID. 
     256         * @param array   $instance   Current widget instance arguments. 
     257         * @return string 
     258         */ 
     259        private function render_video( $attachment, $widget_id, $instance ) { 
     260                unset( $widget_id ); 
     261                if ( in_array( $instance['link'], array( 'file', 'post' ), true ) ) { 
     262                        return $this->create_link_for( $attachment, $instance['link'] ); 
     263                } 
     264 
     265                return wp_video_shortcode( array( 
     266                        'src' => wp_get_attachment_url( $attachment->ID ), 
     267                ) ); 
     268        } 
     269 
     270        /** 
     271         * Get styles for responsifying the widget 
     272         * 
     273         * @since 4.8.0 
     274         * @access private 
     275         * 
     276         * @param WP_Post $attachment Attachment object. 
     277         * @param string  $widget_id  Widget ID. 
     278         * @return string styles for responsive media 
     279         */ 
     280        private function get_responsive_style( $attachment, $widget_id ) { 
     281                if ( wp_attachment_is( 'audio', $attachment ) ) { 
     282                        return; 
     283                } 
     284 
     285                $output = '<style type="text/css">'; 
     286 
     287                if ( wp_attachment_is_image( $attachment ) ) { 
     288                        $output .= "#{$widget_id}-caption{ width: 100% !important; }"; 
     289                } 
     290 
     291                if ( wp_attachment_is( 'video', $attachment ) ) { 
     292                        $output .= "#{$widget_id} .wp-video{ width: 100% !important; }"; 
     293                } 
     294 
     295                $output .= '</style>'; 
     296 
     297                return $output; 
     298        } 
     299 
     300 
     301        /** 
     302         * Creates and returns a link for an attachment 
     303         * 
     304         * @param WP_Post $attachment Attachment object. 
     305         * @param string  $type       link type. 
     306         * @return string 
     307         */ 
     308        private function create_link_for( $attachment, $type = '' ) { 
     309                $url = '#'; 
     310                if ( 'file' === $type ) { 
     311                        $url = wp_get_attachment_url( $attachment->ID ); 
     312                } elseif ( 'post' === $type ) { 
     313                        $url = get_attachment_link( $attachment->ID ); 
     314                } 
     315 
     316                return '<a href="' . esc_url( $url ) . '">' . $attachment->post_title . '</a>'; 
     317        } 
     318 
     319        /** 
     320         * Outputs the settings update form. 
     321         * 
     322         * @since 4.8.0 
     323         * @access public 
     324         * 
     325         * @param array $saved_instance Current settings. 
     326         * @return void 
     327         */ 
     328        public function form( $saved_instance ) { 
     329                $defaults = array( 
     330                        'title'  => '', 
     331                        // Attachment props. 
     332                        'id'     => '', 
     333                        'align'  => '', 
     334                        'size'   => '', 
     335                        'link'   => '', 
     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}