<!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>[20031] trunk/wp-includes: Improve page loads in the theme customizer by layering loading iframes.</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, #logmsg > ol { margin-left: 0; 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/20031">20031</a></dd>
<dt>Author</dt> <dd>koopersmith</dd>
<dt>Date</dt> <dd>2012-02-29 01:17:21 +0000 (Wed, 29 Feb 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve page loads in the theme customizer by layering loading iframes. Automate refreshing, but debounce multiple refresh events to prevent hammering the server with requests. see <a href="http://core.trac.wordpress.org/ticket/19910">#19910</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludescustomizecontrolsphp">trunk/wp-includes/customize-controls.php</a></li>
<li><a href="#trunkwpincludesjscustomizecontrolsdevjs">trunk/wp-includes/js/customize-controls.dev.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludescustomizecontrolsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/customize-controls.php (20030 => 20031)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/customize-controls.php 2012-02-28 21:41:19 UTC (rev 20030)
+++ trunk/wp-includes/customize-controls.php 2012-02-29 01:17:21 UTC (rev 20031)
</span><span class="lines">@@ -69,7 +69,6 @@
</span><span class="cx">
</span><span class="cx"> <div id="customize-footer" class="customize-section">
</span><span class="cx"> <?php
</span><del>- submit_button( __( 'Refresh' ), 'secondary', 'refresh', false );
</del><span class="cx"> submit_button( __( 'Save' ), 'primary', 'save', false );
</span><span class="cx"> ?>
</span><span class="cx"> </div>
</span></span></pre></div>
<a id="trunkwpincludesjscustomizecontrolsdevjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/customize-controls.dev.js (20030 => 20031)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/customize-controls.dev.js 2012-02-28 21:41:19 UTC (rev 20030)
+++ trunk/wp-includes/js/customize-controls.dev.js 2012-02-29 01:17:21 UTC (rev 20031)
</span><span class="lines">@@ -2,6 +2,8 @@
</span><span class="cx"> var api = wp.customize;
</span><span class="cx">
</span><span class="cx"> api.Previewer = api.Messenger.extend({
</span><ins>+ refreshBuffer: 250,
+
</ins><span class="cx"> /**
</span><span class="cx"> * Requires params:
</span><span class="cx"> * - iframe - a selector or jQuery element
</span><span class="lines">@@ -11,9 +13,49 @@
</span><span class="cx"> initialize: function( params, options ) {
</span><span class="cx"> $.extend( this, options || {} );
</span><span class="cx">
</span><ins>+ this.loaderUuid = 0;
+
+ /*
+ * Wrap this.refresh to prevent it from hammering the servers:
+ *
+ * If refresh is called once and no other refresh requests are
+ * loading, trigger the request immediately.
+ *
+ * If refresh is called while another refresh request is loading,
+ * debounce the refresh requests:
+ * 1. Stop the loading request (as it is instantly outdated).
+ * 2. Trigger the new request once refresh hasn't been called for
+ * self.refreshBuffer milliseconds.
+ */
+ this.refresh = (function( self ) {
+ var refresh = self.refresh,
+ callback = function() {
+ timeout = null;
+ refresh.call( self );
+ },
+ timeout;
+
+ return function() {
+ if ( typeof timeout !== 'number' ) {
+ if ( self.loading ) {
+ self.loading.remove();
+ delete self.loading;
+ self.loader();
+ } else {
+ return callback();
+ }
+ }
+
+ clearTimeout( timeout );
+ timeout = setTimeout( callback, self.refreshBuffer );
+ };
+ })( this );
+
</ins><span class="cx"> this.iframe = api.ensure( params.iframe );
</span><span class="cx"> this.form = api.ensure( params.form );
</span><span class="cx">
</span><ins>+ this.container = this.iframe.parent();
+
</ins><span class="cx"> api.Messenger.prototype.initialize.call( this, params.url, {
</span><span class="cx"> targetWindow: this.iframe[0].contentWindow
</span><span class="cx"> });
</span><span class="lines">@@ -34,9 +76,31 @@
</span><span class="cx">
</span><span class="cx"> this.refresh();
</span><span class="cx"> },
</span><ins>+ loader: function() {
+ var self = this,
+ name;
+
+ if ( this.loading )
+ return this.loading;
+
+ name = this.iframe.prop('name');
+
+ this.loading = $('<iframe />', {
+ name: name + '-loading-' + this.loaderUuid++
+ }).appendTo( this.container );
+
+ this.loading.one( 'load', function() {
+ self.iframe.remove();
+ self.iframe = self.loading;
+ delete self.loading;
+ self.iframe.prop( 'name', name );
+ });
+
+ return this.loading;
+ },
</ins><span class="cx"> refresh: function() {
</span><span class="cx"> this.submit({
</span><del>- target: this.iframe.prop('name'),
</del><ins>+ target: this.loader().prop('name'),
</ins><span class="cx"> action: this.url()
</span><span class="cx"> });
</span><span class="cx"> },
</span><span class="lines">@@ -54,6 +118,9 @@
</span><span class="cx"> * ===================================================================== */
</span><span class="cx">
</span><span class="cx"> $( function() {
</span><ins>+ if ( ! api.settings )
+ return;
+
</ins><span class="cx"> var previewer,
</span><span class="cx"> controls = $('[name^="' + api.settings.prefix + '"]');
</span><span class="cx">
</span><span class="lines">@@ -72,6 +139,8 @@
</span><span class="cx">
</span><span class="cx"> setting.control.link( setting );
</span><span class="cx"> setting.link( setting.control );
</span><ins>+
+ setting.bind( previewer.refresh );
</ins><span class="cx"> });
</span><span class="cx">
</span><span class="cx"> // Temporary accordion code.
</span><span class="lines">@@ -87,11 +156,6 @@
</span><span class="cx"> return false;
</span><span class="cx"> });
</span><span class="cx">
</span><del>- $('#refresh').click( function() {
- previewer.refresh();
- return false;
- });
-
</del><span class="cx"> // Fetch prefixed settings.
</span><span class="cx"> $('[name^="' + api.settings.prefix + '"]').each( function() {
</span><span class="cx"> // console.log( this.name );
</span></span></pre>
</div>
</div>
</body>
</html>