<!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>[30014] trunk/src: Add the ability for a customizer control to render its controls via a JavaScript template.</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/30014">30014</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/30014","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-24 16:31:54 +0000 (Fri, 24 Oct 2014)</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'>Add the ability for a customizer control to render its controls via a JavaScript template. Switches the default color picker control to a JavaScript template. See <a href="https://core.trac.wordpress.org/ticket/29572">#29572</a>. Props celloexpressions</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincustomizephp">trunk/src/wp-admin/customize.php</a></li>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.js</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizecontrolphp">trunk/src/wp-includes/class-wp-customize-control.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincustomizephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/customize.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/customize.php 2014-10-24 15:14:02 UTC (rev 30013)
+++ trunk/src/wp-admin/customize.php 2014-10-24 16:31:54 UTC (rev 30014)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,6 +180,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <div id="customize-preview" class="wp-full-overlay-main"></div>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Render control templates.
+ $wp_customize->render_control_templates();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Print Customizer control scripts in the footer.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcwpadminjscustomizecontrolsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/customize-controls.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-controls.js 2014-10-24 15:14:02 UTC (rev 30013)
+++ trunk/src/wp-admin/js/customize-controls.js 2014-10-24 16:31:54 UTC (rev 30014)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,7 +60,10 @@
</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"> control.setting = control.settings['default'] || null;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- control.ready();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ control.renderContent( function() {
+ // Don't call ready() until the content has rendered.
+ control.ready();
+ } );
</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"> control.elements = [];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,6 +152,24 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> this.setting.bind( update );
</span><span class="cx" style="display: block; padding: 0 10px"> update( this.setting() );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ },
+
+ /**
+ * Render the control from its JS template, if it exists.
+ *
+ * The control's container must alreasy exist in the DOM.
+ */
+ renderContent: function( callback ) {
+ var template,
+ selector = 'customize-control-' + this.params.type + '-content',
+ callback = callback || function(){};
+ if ( 0 !== $( '#tmpl-' + selector ).length ) {
+ template = wp.template( selector );
+ if ( template && this.container ) {
+ this.container.append( template( this.params ) );
+ }
+ }
+ callback();
</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></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizecontrolphp"></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/class-wp-customize-control.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-control.php 2014-10-24 15:14:02 UTC (rev 30013)
+++ trunk/src/wp-includes/class-wp-customize-control.php 2014-10-24 16:31:54 UTC (rev 30014)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -217,8 +217,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->json['settings'][ $key ] = $setting->id;
</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">- $this->json['type'] = $this->type;
- $this->json['active'] = $this->active();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->json['type'] = $this->type;
+ $this->json['label'] = $this->label;
+ $this->json['description'] = $this->description;
+ $this->json['active'] = $this->active();
</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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -336,6 +338,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Supports basic input types `text`, `checkbox`, `textarea`, `radio`, `select` and `dropdown-pages`.
</span><span class="cx" style="display: block; padding: 0 10px"> * Additional input types such as `email`, `url`, `number`, `hidden` and `date` are supported implicitly.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Control content can alternately be rendered in JS. See {@see WP_Customize_Control::print_template()}.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function render_content() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -443,6 +447,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</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">+
+ /**
+ * Render the control's JS template.
+ *
+ * This function is only run for control types that have been registered with {@see WP_Customize_Manager::register_control_type()}.
+ *
+ * In the future, this will also print the template for the control's container element and be overridable.
+ *
+ * @since 4.1.0
+ */
+ final public function print_template() {
+ ?>
+ <script type="text/html" id="tmpl-customize-control-<?php echo $this->type; ?>-content">
+ <?php $this->content_template(); ?>
+ </script>
+ <?php
+ }
+
+ /**
+ * An Underscore (JS) template for this control's content (but not its container).
+ *
+ * Class variables for this control class are available in the `data` JS object;
+ * export custom variables by overriding {@see WP_Customize_Control::to_json()}.
+ *
+ * @see WP_Customize_Control::print_template()
+ *
+ * @since 4.1.0
+ */
+ protected function content_template() {}
+
</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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -499,33 +533,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function to_json() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::to_json();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->json['statuses'] = $this->statuses;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->json['defaultValue'] = $this->setting->default;
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Render the control's content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Don't render the control content from PHP, as it's rendered via JS on load.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function render_content() {
- $this_default = $this->setting->default;
- $default_attr = '';
- if ( $this_default ) {
- if ( false === strpos( $this_default, '#' ) )
- $this_default = '#' . $this_default;
- $default_attr = ' data-default-color="' . esc_attr( $this_default ) . '"';
- }
- // The input's value gets set by JS. Don't fill it.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function render_content() {}
+
+ /**
+ * Render a JS template for the content of the color picker control.
+ *
+ * @since 4.1.0
+ */
+ public function content_template() {
</ins><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <# var defaultValue = '';
+ if ( data.defaultValue ) {
+ if ( '#' !== data.defaultValue.substring( 0, 1 ) ) {
+ defaultValue = '#' + data.defaultValue;
+ }
+ defaultValue = ' data-default-color=' + defaultValue; // Quotes added automatically.
+ } #>
</ins><span class="cx" style="display: block; padding: 0 10px"> <label>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php if ( ! empty( $this->label ) ) : ?>
- <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
- <?php endif;
- if ( ! empty( $this->description ) ) : ?>
- <span class="description customize-control-description"><?php echo $this->description; ?></span>
- <?php endif; ?>
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <# if ( data.label ) { #>
+ <span class="customize-control-title">{{ data.label }}</span>
+ <# } #>
+ <# if ( data.description ) { #>
+ <span class="description customize-control-description">{{ data.description }}</span>
+ <# } #>
</ins><span class="cx" style="display: block; padding: 0 10px"> <div class="customize-control-content">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <input class="color-picker-hex" type="text" maxlength="7" placeholder="<?php esc_attr_e( 'Hex Value' ); ?>"<?php echo $default_attr; ?> />
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <input class="color-picker-hex" type="text" maxlength="7" placeholder="<?php esc_attr_e( 'Hex Value' ); ?>" {{ defaultValue }} />
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> </label>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizemanagerphp"></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/class-wp-customize-manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-manager.php 2014-10-24 15:14:02 UTC (rev 30013)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2014-10-24 16:31:54 UTC (rev 30014)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,6 +54,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $customized;
</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">+ * Controls that may be rendered from JS templates.
+ *
+ * @since 4.1.0
+ */
+ protected $registered_control_types = array();
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * $_POST values for Customize Settings.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -822,6 +829,32 @@
</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">+ * Register a customize control type.
+ *
+ * Registered types are eligible to be rendered
+ * via JS and created dynamically.
+ *
+ * @since 4.1.0
+ *
+ * @param string $control Name of a custom control which is a subclass of {@see WP_Customize_Control}.
+ */
+ public function register_control_type( $control ) {
+ $this->registered_control_types[] = $control;
+ }
+
+ /**
+ * Render JS templates for all registered control types.
+ *
+ * @since 4.1.0
+ */
+ public function render_control_templates() {
+ foreach( $this->registered_control_types as $control_type ) {
+ $control = new $control_type( $this, 'temp', array() );
+ $control->print_template();
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Helper function to compare two objects by priority.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -927,6 +960,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function register_controls() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* Control Types (custom control classes) */
+ $this->register_control_type( 'WP_Customize_Color_Control' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /* Site Title & Tagline */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->add_section( 'title_tagline', array(
</span></span></pre>
</div>
</div>
</body>
</html>