<!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>[29451] trunk/src: Add some docs to Customizer JS.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/29451">29451</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-08-08 23:30:30 +0000 (Fri, 08 Aug 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add some docs to Customizer JS.
Props ericlewis.
See <a href="http://core.trac.wordpress.org/ticket/29157">#29157</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.js</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
<li><a href="#trunksrcwpincludesjscustomizepreviewjs">trunk/src/wp-includes/js/customize-preview.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscustomizecontrolsjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/js/customize-controls.js (29450 => 29451)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/js/customize-controls.js 2014-08-08 22:09:46 UTC (rev 29450)
+++ trunk/src/wp-admin/js/customize-controls.js 2014-08-08 23:30:30 UTC (rev 29451)
</span><span class="lines">@@ -3,6 +3,10 @@
</span><span class="cx"> var api = wp.customize;
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * @constructor
+ * @augments wp.customize.Value
+ * @augments wp.customize.Class
+ *
</ins><span class="cx"> * @param options
</span><span class="cx"> * - previewer - The Previewer instance to sync with.
</span><span class="cx"> * - transport - The transport to use for previewing. Supports 'refresh' and 'postMessage'.
</span><span class="lines">@@ -26,6 +30,10 @@
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.Class
+ */
</ins><span class="cx"> api.Control = api.Class.extend({
</span><span class="cx"> initialize: function( id, options ) {
</span><span class="cx"> var control = this,
</span><span class="lines">@@ -87,6 +95,9 @@
</span><span class="cx"> control.toggle( control.active() );
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ /**
+ * @abstract
+ */
</ins><span class="cx"> ready: function() {},
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -141,6 +152,11 @@
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
</ins><span class="cx"> api.ColorControl = api.Control.extend({
</span><span class="cx"> ready: function() {
</span><span class="cx"> var control = this,
</span><span class="lines">@@ -157,6 +173,11 @@
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
</ins><span class="cx"> api.UploadControl = api.Control.extend({
</span><span class="cx"> ready: function() {
</span><span class="cx"> var control = this;
</span><span class="lines">@@ -210,6 +231,12 @@
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.UploadControl
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
</ins><span class="cx"> api.ImageControl = api.UploadControl.extend({
</span><span class="cx"> ready: function() {
</span><span class="cx"> var control = this,
</span><span class="lines">@@ -328,6 +355,11 @@
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
</ins><span class="cx"> api.HeaderControl = api.Control.extend({
</span><span class="cx"> ready: function() {
</span><span class="cx"> this.btnRemove = $('#customize-control-header_image .actions .remove');
</span><span class="lines">@@ -544,6 +576,12 @@
</span><span class="cx"> // Create the collection of Control objects.
</span><span class="cx"> api.control = new api.Values({ defaultConstructor: api.Control });
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.Messenger
+ * @augments wp.customize.Class
+ * @mixes wp.customize.Events
+ */
</ins><span class="cx"> api.PreviewFrame = api.Messenger.extend({
</span><span class="cx"> sensitivity: 2000,
</span><span class="cx">
</span><span class="lines">@@ -714,11 +752,22 @@
</span><span class="cx">
</span><span class="cx"> (function(){
</span><span class="cx"> var uuid = 0;
</span><ins>+ /**
+ * Create a universally unique identifier.
+ *
+ * @return {int}
+ */
</ins><span class="cx"> api.PreviewFrame.uuid = function() {
</span><span class="cx"> return 'preview-' + uuid++;
</span><span class="cx"> };
</span><span class="cx"> }());
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.Messenger
+ * @augments wp.customize.Class
+ * @mixes wp.customize.Events
+ */
</ins><span class="cx"> api.Previewer = api.Messenger.extend({
</span><span class="cx"> refreshBuffer: 250,
</span><span class="cx">
</span><span class="lines">@@ -924,10 +973,6 @@
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><del>- /* =====================================================================
- * Ready.
- * ===================================================================== */
-
</del><span class="cx"> api.controlConstructor = {
</span><span class="cx"> color: api.ColorControl,
</span><span class="cx"> upload: api.UploadControl,
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizemanagerphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-customize-manager.php (29450 => 29451)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-customize-manager.php 2014-08-08 22:09:46 UTC (rev 29450)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2014-08-08 23:30:30 UTC (rev 29451)
</span><span class="lines">@@ -16,7 +16,7 @@
</span><span class="cx"> */
</span><span class="cx"> final class WP_Customize_Manager {
</span><span class="cx"> /**
</span><del>- * An instance of the theme that is being customized.
</del><ins>+ * An instance of the theme being previewed.
</ins><span class="cx"> *
</span><span class="cx"> * @var WP_Theme
</span><span class="cx"> */
</span><span class="lines">@@ -30,8 +30,7 @@
</span><span class="cx"> protected $original_stylesheet;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Whether filters have been set to change the active theme to the theme being
- * customized.
</del><ins>+ * Whether this is a Customizer pageload.
</ins><span class="cx"> *
</span><span class="cx"> * @var boolean
</span><span class="cx"> */
</span><span class="lines">@@ -183,7 +182,6 @@
</span><span class="cx"> $this->wp_die( -1 );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // All good, let's do some internal business to preview the theme.
</del><span class="cx"> $this->start_previewing_theme();
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -200,7 +198,8 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Start previewing the selected theme by adding filters to change the current theme.
</del><ins>+ * If the theme to be previewed isn't the active theme, add filter callbacks
+ * to swap it out at runtime.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.4.0
</span><span class="cx"> */
</span></span></pre></div>
<a id="trunksrcwpincludesjscustomizepreviewjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/js/customize-preview.js (29450 => 29451)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/js/customize-preview.js 2014-08-08 22:09:46 UTC (rev 29450)
+++ trunk/src/wp-includes/js/customize-preview.js 2014-08-08 23:30:30 UTC (rev 29451)
</span><span class="lines">@@ -2,6 +2,11 @@
</span><span class="cx"> var api = wp.customize,
</span><span class="cx"> debounce;
</span><span class="cx">
</span><ins>+ /**
+ * Returns a debounced version of the function.
+ *
+ * @todo Require Underscore.js for this file and retire this.
+ */
</ins><span class="cx"> debounce = function( fn, delay, context ) {
</span><span class="cx"> var timeout;
</span><span class="cx"> return function() {
</span><span class="lines">@@ -17,6 +22,12 @@
</span><span class="cx"> };
</span><span class="cx"> };
</span><span class="cx">
</span><ins>+ /**
+ * @constructor
+ * @augments wp.customize.Messenger
+ * @augments wp.customize.Class
+ * @mixes wp.customize.Events
+ */
</ins><span class="cx"> api.Preview = api.Messenger.extend({
</span><span class="cx"> /**
</span><span class="cx"> * Requires params:
</span></span></pre>
</div>
</div>
</body>
</html>