<!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>[35302] trunk: Customizer: Implement indicators for invalid nav menu items.</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/35302">35302</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/35302","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-10-20 19:07:58 +0000 (Tue, 20 Oct 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: Implement indicators for invalid nav menu items.
The same indicator on the nav menus admin page is now present for nav menu items in the Customizer. When a menu item is present for a post type that is no longer registered, the menu item will appear with the indicator.
Props kucrut, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/33665">#33665</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizenavmenusjs">trunk/src/wp-admin/js/customize-nav-menus.js</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizesettingphp">trunk/src/wp-includes/class-wp-customize-setting.php</a></li>
<li><a href="#trunktestsphpunittestscustomizenavmenuitemsettingphp">trunk/tests/phpunit/tests/customize/nav-menu-item-setting.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscustomizenavmenusjs"></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-nav-menus.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-nav-menus.js 2015-10-20 18:35:46 UTC (rev 35301)
+++ trunk/src/wp-admin/js/customize-nav-menus.js 2015-10-20 19:07:58 UTC (rev 35302)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1250,16 +1250,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- var titleEl = control.container.find( '.menu-item-title' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var titleEl = control.container.find( '.menu-item-title' ),
+ titleText = item.title || api.Menus.data.l10n.untitled;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( item._invalid ) {
+ titleText = api.Menus.data.l10n.invalidTitleTpl.replace( '%s', titleText );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Don't update to an empty title.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( item.title ) {
</span><span class="cx" style="display: block; padding: 0 10px"> titleEl
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- .text( item.title )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ .text( titleText )
</ins><span class="cx" style="display: block; padding: 0 10px"> .removeClass( 'no-title' );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> titleEl
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- .text( api.Menus.data.l10n.untitled )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ .text( titleText )
</ins><span class="cx" style="display: block; padding: 0 10px"> .addClass( 'no-title' );
</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">@@ -1303,9 +1308,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'menu-item-edit-inactive'
</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">- if ( settingValue.invalid ) {
- containerClasses.push( 'invalid' );
- control.params.title = api.Menus.data.invalidTitleTpl.replace( '%s', control.params.title );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( settingValue._invalid ) {
+ containerClasses.push( 'menu-item-invalid' );
+ control.params.title = api.Menus.data.l10n.invalidTitleTpl.replace( '%s', control.params.title );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else if ( 'draft' === settingValue.status ) {
</span><span class="cx" style="display: block; padding: 0 10px"> containerClasses.push( 'pending' );
</span><span class="cx" style="display: block; padding: 0 10px"> control.params.title = api.Menus.data.pendingTitleTpl.replace( '%s', control.params.title );
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizesettingphp"></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-setting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-setting.php 2015-10-20 18:35:46 UTC (rev 35301)
+++ trunk/src/wp-includes/class-wp-customize-setting.php 2015-10-20 19:07:58 UTC (rev 35302)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -885,7 +885,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'status' => 'publish',
</span><span class="cx" style="display: block; padding: 0 10px"> 'original_title' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'nav_menu_term_id' => 0, // This will be supplied as the $menu_id arg for wp_update_nav_menu_item().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // @todo also expose invalid?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '_invalid' => false,
</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">@@ -1144,6 +1144,14 @@
</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">+ if ( ! isset( $this->value['_invalid'] ) ) {
+ $this->value['_invalid'] = (
+ ( 'post_type' === $this->value['type'] && ! post_type_exists( $this->value['object'] ) )
+ ||
+ ( 'taxonomy' === $this->value['type'] && ! taxonomy_exists( $this->value['object'] ) )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Remove remaining properties available on a setup nav_menu_item post object which aren't relevant to the setting value.
</span><span class="cx" style="display: block; padding: 0 10px"> $irrelevant_properties = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'ID',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1246,6 +1254,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $should_remove = (
</span><span class="cx" style="display: block; padding: 0 10px"> false === $this_item
</span><span class="cx" style="display: block; padding: 0 10px"> ||
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ true === $this_item['_invalid']
+ ||
</ins><span class="cx" style="display: block; padding: 0 10px"> (
</span><span class="cx" style="display: block; padding: 0 10px"> $this->original_nav_menu_term_id === $menu->term_id
</span><span class="cx" style="display: block; padding: 0 10px"> &&
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1417,6 +1427,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'status' => 'publish',
</span><span class="cx" style="display: block; padding: 0 10px"> 'original_title' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'nav_menu_term_id' => 0,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '_invalid' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_item_value = array_merge( $default, $menu_item_value );
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_item_value = wp_array_slice_assoc( $menu_item_value, array_keys( $default ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1449,6 +1460,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_item_value['status'] = 'publish';
</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">+ $menu_item_value['_invalid'] = (bool) $menu_item_value['_invalid'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/class-wp-customize-setting.php */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( "customize_sanitize_{$this->id}", $menu_item_value, $this );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizenavmenuitemsettingphp"></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-menu-item-setting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/nav-menu-item-setting.php 2015-10-20 18:35:46 UTC (rev 35301)
+++ trunk/tests/phpunit/tests/customize/nav-menu-item-setting.php 2015-10-20 19:07:58 UTC (rev 35302)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,6 +92,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'status' => 'publish',
</span><span class="cx" style="display: block; padding: 0 10px"> 'original_title' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'nav_menu_term_id' => 0,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '_invalid' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $default, $setting->default );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -458,6 +459,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'status' => 'forbidden',
</span><span class="cx" style="display: block; padding: 0 10px"> 'original_title' => 'Hi<script>alert(1)</script>',
</span><span class="cx" style="display: block; padding: 0 10px"> 'nav_menu_term_id' => 'heilo',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '_invalid' => false,
</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"> $sanitized = $setting->sanitize( $unsanitized );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -664,4 +666,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'deleted', $update_result['status'] );
</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">+ /**
+ * @ticket 33665
+ */
+ function test_invalid_nav_menu_item() {
+ $menu_id = wp_create_nav_menu( 'Primary' );
+ register_post_type( 'poem', array(
+ 'public' => true,
+ ) );
+
+ $post_id = self::factory()->post->create( array( 'post_type' => 'poem', 'post_title' => 'Code is poetry.' ) );
+ $post = get_post( $post_id );
+ $item_id = wp_update_nav_menu_item( $menu_id, 0, array(
+ 'menu-item-type' => 'post_type',
+ 'menu-item-object' => 'poem',
+ 'menu-item-object-id' => $post_id,
+ 'menu-item-title' => $post->post_title,
+ 'menu-item-status' => 'publish',
+ 'menu-item-position' => 1,
+ ) );
+ $setting_id = "nav_menu_item[$item_id]";
+
+ do_action( 'customize_register', $this->wp_customize );
+ $setting = $this->wp_customize->get_setting( $setting_id );
+ $this->assertNotEmpty( $setting );
+ $value = $setting->value();
+ $this->assertFalse( $value['_invalid'] );
+ $value_object = $setting->value_as_wp_post_nav_menu_item();
+ $this->assertFalse( $value_object->_invalid );
+
+ $setting = new WP_Customize_Nav_Menu_Item_Setting( $this->wp_customize, $setting_id );
+ $value = $setting->value();
+ $this->assertFalse( $value['_invalid'] );
+ $value_object = $setting->value_as_wp_post_nav_menu_item();
+ $this->assertFalse( $value_object->_invalid );
+
+ _unregister_post_type( 'poem' );
+ $setting = new WP_Customize_Nav_Menu_Item_Setting( $this->wp_customize, $setting_id );
+ $value = $setting->value();
+ $this->assertTrue( $value['_invalid'] );
+ $value_object = $setting->value_as_wp_post_nav_menu_item();
+ $this->assertTrue( $value_object->_invalid );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>