<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[42613] trunk: Customize: Ensure media playlists get initialized after selective refresh; expose new `wp.playlist.initialize()` API.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/42613">42613</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42613","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-01-29 23:55:44 +0000 (Mon, 29 Jan 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Customize: Ensure media playlists get initialized after selective refresh; expose new `wp.playlist.initialize()` API.
In particular allows audio and video playlists to be added to the Text widget and previewed.
Props bpayton, westonruter.
See <a href="https://core.trac.wordpress.org/ticket/40854">#40854</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/42495">#42495</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjscustomizeselectiverefreshjs">trunk/src/wp-includes/js/customize-selective-refresh.js</a></li>
<li><a href="#trunksrcwpincludesjsmediaelementwpplaylistjs">trunk/src/wp-includes/js/mediaelement/wp-playlist.js</a></li>
<li><a href="#trunksrcwpincludeswidgetsclasswpwidgettextphp">trunk/src/wp-includes/widgets/class-wp-widget-text.php</a></li>
<li><a href="#trunktestsphpunittestswidgetstextwidgetphp">trunk/tests/phpunit/tests/widgets/text-widget.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjscustomizeselectiverefreshjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/customize-selective-refresh.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/customize-selective-refresh.js 2018-01-29 23:04:22 UTC (rev 42612)
+++ trunk/src/wp-includes/js/customize-selective-refresh.js 2018-01-29 23:55:44 UTC (rev 42613)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -488,6 +488,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp.mediaelement.initialize();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp.playlist ) {
+ wp.playlist.initialize();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Announce when a partial's placement has been rendered so that dynamic elements can be re-built.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludesjsmediaelementwpplaylistjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/mediaelement/wp-playlist.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/mediaelement/wp-playlist.js 2018-01-29 23:04:22 UTC (rev 42612)
+++ trunk/src/wp-includes/js/mediaelement/wp-playlist.js 2018-01-29 23:55:44 UTC (rev 42613)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,6 +3,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> (function ($, _, Backbone) {
</span><span class="cx" style="display: block; padding: 0 10px"> 'use strict';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** @namespace wp */
+ window.wp = window.wp || {};
+
</ins><span class="cx" style="display: block; padding: 0 10px"> var WPPlaylistView = Backbone.View.extend(/** @lends WPPlaylistView.prototype */{
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @constructs
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -168,12 +171,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $(document).ready(function () {
- $('.wp-playlist').each( function() {
- return new WPPlaylistView({ el: this });
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Initialize media playlists in the document.
+ *
+ * Only initializes new playlists not previously-initialized.
+ *
+ * @since 4.9.3
+ * @returns {void}
+ */
+ function initialize() {
+ $( '.wp-playlist:not(:has(.mejs-container))' ).each( function() {
+ new WPPlaylistView( { el: this } );
</ins><span class="cx" style="display: block; padding: 0 10px"> } );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- });
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Expose the API publicly on window.wp.playlist.
+ *
+ * @namespace wp.playlist
+ * @since 4.9.3
+ * @type {object}
+ */
+ window.wp.playlist = {
+ initialize: initialize
+ };
+
+ $( document ).ready( initialize );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> window.WPPlaylistView = WPPlaylistView;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> }(jQuery, _, Backbone));
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsclasswpwidgettextphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/widgets/class-wp-widget-text.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets/class-wp-widget-text.php 2018-01-29 23:04:22 UTC (rev 42612)
+++ trunk/src/wp-includes/widgets/class-wp-widget-text.php 2018-01-29 23:55:44 UTC (rev 42613)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,6 +57,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_add_inline_script( 'text-widgets', sprintf( 'wp.textWidgets.idBases.push( %s );', wp_json_encode( $this->id_base ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $this->is_preview() ) {
+ add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_preview_scripts' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Note that the widgets component in the customizer will also do the 'admin_print_scripts-widgets.php' action in WP_Customize_Widgets::print_scripts().
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_print_scripts-widgets.php', array( $this, 'enqueue_admin_scripts' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -394,6 +398,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Enqueue preview scripts.
+ *
+ * These scripts normally are enqueued just-in-time when a playlist shortcode is used.
+ * However, in the customizer, a playlist shortcode may be used in a text widget and
+ * dynamically added via selective refresh, so it is important to unconditionally enqueue them.
+ *
+ * @since 4.9.3
+ */
+ public function enqueue_preview_scripts() {
+ require_once dirname( dirname( __FILE__ ) ) . '/media.php';
+
+ wp_playlist_scripts( 'audio' );
+ wp_playlist_scripts( 'video' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Loads the required scripts and styles for the widget control.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.8.0
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetstextwidgetphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/widgets/text-widget.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/text-widget.php 2018-01-29 23:04:22 UTC (rev 42612)
+++ trunk/tests/phpunit/tests/widgets/text-widget.php 2018-01-29 23:55:44 UTC (rev 42613)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,9 +66,63 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 10, has_action( 'admin_print_scripts-widgets.php', array( $widget, 'enqueue_admin_scripts' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 10, has_action( 'admin_footer-widgets.php', array( 'WP_Widget_Text', 'render_control_template_scripts' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'wp.textWidgets.idBases.push( "text" );', wp_scripts()->registered['text-widgets']->extra['after'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertFalse( has_action( 'wp_enqueue_scripts', array( $widget, 'enqueue_preview_scripts' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test register in customize preview.
+ *
+ * @global WP_Customize_Manager $wp_customize
+ * @covers WP_Widget_Text::__construct()
+ * @covers WP_Widget_Text::_register()
+ */
+ function test__register_in_customize_preview() {
+ global $wp_customize;
+ wp_set_current_user(
+ $this->factory()->user->create(
+ array(
+ 'role' => 'administrator',
+ )
+ )
+ );
+ require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
+ $wp_customize = new WP_Customize_Manager(
+ array(
+ 'changeset_uuid' => wp_generate_uuid4(),
+ )
+ );
+ $wp_customize->start_previewing_theme();
+
+ $widget = new WP_Widget_Text();
+ $widget->_register();
+ $this->assertEquals( 10, has_action( 'wp_enqueue_scripts', array( $widget, 'enqueue_preview_scripts' ) ) );
+ }
+
+ /**
+ * Test enqueue_preview_scripts method.
+ *
+ * @global WP_Scripts $wp_scripts
+ * @global WP_Styles $wp_styles
+ * @covers WP_Widget_Text::enqueue_preview_scripts
+ */
+ function test_enqueue_preview_scripts() {
+ global $wp_scripts, $wp_styles;
+ $wp_scripts = null;
+ $wp_styles = null;
+ $widget = new WP_Widget_Text();
+
+ $this->assertFalse( wp_style_is( 'wp-mediaelement' ) );
+ $this->assertFalse( wp_script_is( 'wp-playlist' ) );
+
+ ob_start();
+ $widget->enqueue_preview_scripts();
+ ob_end_clean();
+
+ $this->assertTrue( wp_style_is( 'wp-mediaelement' ) );
+ $this->assertTrue( wp_script_is( 'wp-playlist' ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test widget method.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Widget_Text::widget
</span></span></pre>
</div>
</div>
</body>
</html>