<!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>[33138] trunk: Customizer: Remove additional wrapper element around `wp_nav_menu()` which broke some theme designs.</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/33138">33138</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/33138","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>2015-07-08 21:29:53 +0000 (Wed, 08 Jul 2015)</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'>Customizer: Remove additional wrapper element around `wp_nav_menu()` which broke some theme designs.
Also includes these related changes:
* Export `oldContainer` and `newContainer` among the `customize-preview-menu-refreshed` event params for themes to be able to more easily re-initialize the DOM elements.
* Improve performance for partial refresh by only sending settings related to the menu being previewed.
* Fix previewing of menu assigned to Custom Menu by exporting a menu `term_id` as opposed to an object, as the former is more stable for comparing in in args hashes.
* Do full refresh of preview when nav menu unassigned so that the layout can be updated.
* Harden conditions for when partial refresh is eligible for a `wp_nav_menu()` instance.
Fixes <a href="https://core.trac.wordpress.org/ticket/32841">#32841</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizenavmenusphp">trunk/src/wp-includes/class-wp-customize-nav-menus.php</a></li>
<li><a href="#trunksrcwpincludesjscustomizepreviewnavmenusjs">trunk/src/wp-includes/js/customize-preview-nav-menus.js</a></li>
<li><a href="#trunktestsphpunittestscustomizenavmenusphp">trunk/tests/phpunit/tests/customize/nav-menus.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcustomizenavmenusphp"></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-nav-menus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-nav-menus.php 2015-07-08 21:27:25 UTC (rev 33137)
+++ trunk/src/wp-includes/class-wp-customize-nav-menus.php 2015-07-08 21:29:53 UTC (rev 33138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -768,6 +768,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ( empty( $args['fallback_cb'] ) || is_string( $args['fallback_cb'] ) )
</span><span class="cx" style="display: block; padding: 0 10px"> &&
</span><span class="cx" style="display: block; padding: 0 10px"> ( empty( $args['walker'] ) || is_string( $args['walker'] ) )
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ &&
+ (
+ ! empty( $args['theme_location'] )
+ ||
+ ( ! empty( $args['menu'] ) && ( is_numeric( $args['menu'] ) || is_object( $args['menu'] ) ) )
+ )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $args['can_partial_refresh'] = $can_partial_refresh;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -778,6 +784,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $hashed_args['walker'] = '';
</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">+ // Replace object menu arg with a term_id menu arg, as this exports better to JS and is easier to compare hashes.
+ if ( ! empty( $hashed_args['menu'] ) && is_object( $hashed_args['menu'] ) ) {
+ $hashed_args['menu'] = $hashed_args['menu']->term_id;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> ksort( $hashed_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $hashed_args['args_hash'] = $this->hash_nav_menu_args( $hashed_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -798,10 +809,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function filter_wp_nav_menu( $nav_menu_content, $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $args->can_partial_refresh ) && ! empty( $args->instance_number ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $nav_menu_content = sprintf(
- '<div id="partial-refresh-menu-container-%1$d" class="partial-refresh-menu-container" data-instance-number="%1$d">%2$s</div>',
- $args->instance_number,
- $nav_menu_content
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $nav_menu_content = preg_replace(
+ '/(?<=class=")/',
+ sprintf( 'partial-refreshable-nav-menu partial-refreshable-nav-menu-%1$d ', $args->instance_number ),
+ $nav_menu_content,
+ 1 // Only update the class on the first element found, the menu container.
</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 $nav_menu_content;
</span></span></pre></div>
<a id="trunksrcwpincludesjscustomizepreviewnavmenusjs"></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-preview-nav-menus.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/customize-preview-nav-menus.js 2015-07-08 21:27:25 UTC (rev 33137)
+++ trunk/src/wp-includes/js/customize-preview-nav-menus.js 2015-07-08 21:29:53 UTC (rev 33138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,19 +159,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {int} instanceNumber
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> self.refreshMenuInstance = function( instanceNumber ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var self = this, data, customized, container, request, wpNavArgs, instance;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var self = this, data, menuId, customized, container, request, wpNavArgs, instance, containerInstanceClassName;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! self.navMenuInstanceArgs[ instanceNumber ] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> throw new Error( 'unknown_instance_number' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> instance = self.navMenuInstanceArgs[ instanceNumber ];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- container = $( '#partial-refresh-menu-container-' + String( instanceNumber ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ containerInstanceClassName = 'partial-refreshable-nav-menu-' + String( instanceNumber );
+ container = $( '.' + containerInstanceClassName );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! instance.can_partial_refresh || 0 === container.length ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( _.isNumber( instance.menu ) ) {
+ menuId = instance.menu;
+ } else if ( instance.theme_location && api.has( 'nav_menu_locations[' + instance.theme_location + ']' ) ) {
+ menuId = api( 'nav_menu_locations[' + instance.theme_location + ']' ).get();
+ }
+
+ if ( ! menuId || ! instance.can_partial_refresh || 0 === container.length ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> api.preview.send( 'refresh' );
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ menuId = parseInt( menuId, 10 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> data = {
</span><span class="cx" style="display: block; padding: 0 10px"> nonce: self.previewCustomizeNonce, // for Customize Preview
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -183,8 +191,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> data[ self.renderQueryVar ] = '1';
</span><span class="cx" style="display: block; padding: 0 10px"> customized = {};
</span><span class="cx" style="display: block; padding: 0 10px"> api.each( function( setting, id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // @todo We need to limit this to just the menu items that are associated with this menu/location.
- if ( /^(nav_menu|nav_menu_locations)/.test( id ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // @todo Core should propagate the dirty state into the Preview as well so we can use that here.
+ if ( id === 'nav_menu[' + String( menuId ) + ']' || ( /^nav_menu_item\[/.test( id ) && setting() && menuId === setting().nav_menu_term_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> customized[ id ] = setting.get();
</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">@@ -203,20 +211,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> url: self.requestUri
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px"> request.done( function( data ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var eventParam;
- container.empty().append( $( data ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the menu is now not visible, refresh since the page layout may have changed.
+ if ( false === data ) {
+ api.preview.send( 'refresh' );
+ return;
+ }
+
+ var eventParam, previousContainer = container;
+ container = $( data );
+ container.addClass( containerInstanceClassName );
+ container.addClass( 'partial-refreshable-nav-menu customize-partial-refreshing' );
+ previousContainer.replaceWith( container );
</ins><span class="cx" style="display: block; padding: 0 10px"> eventParam = {
</span><span class="cx" style="display: block; padding: 0 10px"> instanceNumber: instanceNumber,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wpNavArgs: wpNavArgs
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wpNavArgs: wpNavArgs,
+ oldContainer: previousContainer,
+ newContainer: container
</ins><span class="cx" style="display: block; padding: 0 10px"> };
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ container.removeClass( 'customize-partial-refreshing' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $( document ).trigger( 'customize-preview-menu-refreshed', [ eventParam ] );
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- request.fail( function() {
- // @todo provide some indication for why
- } );
- request.always( function() {
- container.removeClass( 'customize-partial-refreshing' );
- } );
</del><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"> self.currentRefreshMenuInstanceDebouncedCalls = {};
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizenavmenusphp"></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/nav-menus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/nav-menus.php 2015-07-08 21:27:25 UTC (rev 33137)
+++ trunk/tests/phpunit/tests/customize/nav-menus.php 2015-07-08 21:29:53 UTC (rev 33138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -353,6 +353,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'echo' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'fallback_cb' => 'wp_page_menu',
</span><span class="cx" style="display: block; padding: 0 10px"> 'walker' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'menu' => wp_create_nav_menu( 'Foo' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1, $results['can_partial_refresh'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -390,6 +391,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $args = $menus->filter_wp_nav_menu_args( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'echo' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'menu' => wp_create_nav_menu( 'Foo' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'fallback_cb' => 'wp_page_menu',
</span><span class="cx" style="display: block; padding: 0 10px"> 'walker' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -401,11 +403,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $object_args = json_decode( json_encode( $args ), false );
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $menus->filter_wp_nav_menu( $nav_menu_content, $object_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<div id="partial-refresh-menu-container-%1$d" class="partial-refresh-menu-container" data-instance-number="%1$d">%2$s</div>',
- $args['instance_number'],
- $nav_menu_content
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<div class="partial-refreshable-nav-menu partial-refreshable-nav-menu-%1$d menu">',
+ $args['instance_number']
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $expected, $result );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertStringStartsWith( $expected, $result );
</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>
</div>
</body>
</html>