<!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>[38513] trunk: Customize: Fix php warning due to `WP_Customize_Manager::prepare_setting_validity_for_js()` incorrectly assuming that `WP_Error` will only ever have arrays in its `$error_data`.</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/38513">38513</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/38513","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>2016-09-02 22:34:48 +0000 (Fri, 02 Sep 2016)</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: Fix php warning due to `WP_Customize_Manager::prepare_setting_validity_for_js()` incorrectly assuming that `WP_Error` will only ever have arrays in its `$error_data`.
* Eliminates the server mutating the a `WP_Error`'s `$error_data` to merge-in a `$from_server` flag (since it may not be an array to begin with). Instead it defers to the client to add a `fromServer` param on any `Notification` instances created from server-sent errors.
* Ensures that notifications will be re-rendered if a notification's `message` changes but the `data` and `type` remain the same.
* Adds explicit support for the `Notification` class to have a `setting` property, ensuring that the property is set whereas previously it was dropped.
Fixes <a href="https://core.trac.wordpress.org/ticket/37890">#37890</a>.
Props westonruter, dlh.</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="#trunksrcwpincludesjscustomizebasejs">trunk/src/wp-includes/js/customize-base.js</a></li>
<li><a href="#trunktestsphpunittestscustomizemanagerphp">trunk/tests/phpunit/tests/customize/manager.php</a></li>
<li><a href="#trunktestsqunitwpadminjscustomizebasejs">trunk/tests/qunit/wp-admin/js/customize-base.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2016-09-02 21:35:51 UTC (rev 38512)
+++ trunk/src/wp-admin/js/customize-controls.js 2016-09-02 22:34:48 UTC (rev 38513)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3461,12 +3461,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Add notifications for invalidities.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( _.isObject( validity ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _.each( validity, function( params, code ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var notification = new api.Notification( code, params ), existingNotification, needsReplacement = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var notification, existingNotification, needsReplacement = false;
+ notification = new api.Notification( code, _.extend( { fromServer: true }, params ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove existing notification if already exists for code but differs in parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> existingNotification = setting.notifications( notification.code );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( existingNotification ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- needsReplacement = ( notification.type !== existingNotification.type ) || ! _.isEqual( notification.data, existingNotification.data );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ needsReplacement = notification.type !== existingNotification.type || notification.message !== existingNotification.message || ! _.isEqual( notification.data, existingNotification.data );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( needsReplacement ) {
</span><span class="cx" style="display: block; padding: 0 10px"> setting.notifications.remove( code );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3715,7 +3716,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> api.each( function( setting ) {
</span><span class="cx" style="display: block; padding: 0 10px"> setting.notifications.each( function( notification ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'error' === notification.type && ( ! notification.data || ! notification.data.from_server ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'error' === notification.type && ! notification.fromServer ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> invalidSettings.push( setting.id );
</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="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 2016-09-02 21:35:51 UTC (rev 38512)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2016-09-02 22:34:48 UTC (rev 38513)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1046,17 +1046,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $validity ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $notification = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $validity->errors as $error_code => $error_messages ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $error_data = $validity->get_error_data( $error_code );
- if ( is_null( $error_data ) ) {
- $error_data = array();
- }
- $error_data = array_merge(
- $error_data,
- array( 'from_server' => true )
- );
</del><span class="cx" style="display: block; padding: 0 10px"> $notification[ $error_code ] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'message' => join( ' ', $error_messages ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'data' => $error_data,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'data' => $validity->get_error_data( $error_code ),
</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"> return $notification;
</span></span></pre></div>
<a id="trunksrcwpincludesjscustomizebasejs"></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-base.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/customize-base.js 2016-09-02 21:35:51 UTC (rev 38512)
+++ trunk/src/wp-includes/js/customize-base.js 2016-09-02 22:34:48 UTC (rev 38513)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -762,18 +762,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @augments wp.customize.Class
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.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">- * @param {string} code The error code.
- * @param {object} params Params.
- * @param {string} params.message The error message.
- * @param {string} [params.type=error] The notification type.
- * @param {*} [params.data] Any additional data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param {string} code - The error code.
+ * @param {object} params - Params.
+ * @param {string} params.message=null - The error message.
+ * @param {string} [params.type=error] - The notification type.
+ * @param {boolean} [params.fromServer=false] - Whether the notification was server-sent.
+ * @param {string} [params.setting=null] - The setting ID that the notification is related to.
+ * @param {*} [params.data=null] - Any additional data.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> api.Notification = api.Class.extend({
</span><span class="cx" style="display: block; padding: 0 10px"> initialize: function( code, params ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var _params;
</ins><span class="cx" style="display: block; padding: 0 10px"> this.code = code;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- this.message = params.message;
- this.type = params.type || 'error';
- this.data = params.data || null;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _params = _.extend(
+ {
+ message: null,
+ type: 'error',
+ fromServer: false,
+ data: null,
+ setting: null
+ },
+ params
+ );
+ delete _params.code;
+ _.extend( this, _params );
</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="trunktestsphpunittestscustomizemanagerphp"></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/customize/manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/manager.php 2016-09-02 21:35:51 UTC (rev 38512)
+++ trunk/tests/phpunit/tests/customize/manager.php 2016-09-02 22:34:48 UTC (rev 38513)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -303,8 +303,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_prepare_setting_validity_for_js() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $this->manager->prepare_setting_validity_for_js( true ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $error = new WP_Error();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $error->add( 'bad_letter', 'Bad letter' );
- $error->add( 'bad_letter', 'Bad letra' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error->add( 'bad_letter', 'Bad letter', 'A' );
+ $error->add( 'bad_letter', 'Bad letra', 123 );
</ins><span class="cx" style="display: block; padding: 0 10px"> $error->add( 'bad_number', 'Bad number', array( 'number' => 123 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $validity = $this->manager->prepare_setting_validity_for_js( $error );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertInternalType( 'array', $validity );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -313,7 +313,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertInternalType( 'array', $validity[ $code ] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( join( ' ', $messages ), $validity[ $code ]['message'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'data', $validity[ $code ] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey( 'from_server', $validity[ $code ]['data'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $validity[ $code ]['data'], $error->get_error_data( $code ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'number', $validity['bad_number']['data'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 123, $validity['bad_number']['data']['number'] );
</span></span></pre></div>
<a id="trunktestsqunitwpadminjscustomizebasejs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/wp-admin/js/customize-base.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/wp-admin/js/customize-base.js 2016-09-02 21:35:51 UTC (rev 38512)
+++ trunk/tests/qunit/wp-admin/js/customize-base.js 2016-09-02 22:34:48 UTC (rev 38513)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,12 +164,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var notification = new wp.customize.Notification( 'mycode', {
</span><span class="cx" style="display: block; padding: 0 10px"> 'message': 'Hello World',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type': 'update',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'setting': 'blogname',
+ 'fromServer': true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'data': { 'foo': 'bar' }
</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"> assert.equal( 'mycode', notification.code );
</span><span class="cx" style="display: block; padding: 0 10px"> assert.equal( 'Hello World', notification.message );
</span><span class="cx" style="display: block; padding: 0 10px"> assert.equal( 'update', notification.type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ assert.equal( 'blogname', notification.setting );
+ assert.equal( true, notification.fromServer );
</ins><span class="cx" style="display: block; padding: 0 10px"> assert.deepEqual( { 'foo': 'bar' }, notification.data );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> notification = new wp.customize.Notification( 'mycode2', {
</span></span></pre>
</div>
</div>
</body>
</html>