<!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>[52170] trunk: Taxonomy: Display update notices when adding terms.</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 { white-space: pre-line; 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/52170">52170</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/52170","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joedolson</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-11-15 22:23:01 +0000 (Mon, 15 Nov 2021)</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'>Taxonomy: Display update notices when adding terms.

Display notice and announce to screen readers when a new term is added. 

Props manishamakhija, birgire, dilipbheda, afercia, hellofromTonya.
Fixes <a href="https://core.trac.wordpress.org/ticket/42937">#42937</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueueslibajaxresponsejs">trunk/src/js/_enqueues/lib/ajax-response.js</a></li>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsajaxAddTagphp">trunk/tests/phpunit/tests/ajax/AddTag.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueueslibajaxresponsejs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/lib/ajax-response.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/lib/ajax-response.js       2021-11-15 22:16:32 UTC (rev 52169)
+++ trunk/src/js/_enqueues/lib/ajax-response.js 2021-11-15 22:23:01 UTC (rev 52170)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,7 +18,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                return r;
</span><span class="cx" style="display: block; padding: 0 10px">        },
</span><span class="cx" style="display: block; padding: 0 10px">        parseAjaxResponse: function( x, r, e ) { // 1 = good, 0 = strange (bad data?), -1 = you lack permission.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                var parsed = {}, re = jQuery('#' + r).empty(), err = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         var parsed = {}, re = jQuery('#' + r).empty(), err = '', successmsg = '';
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                if ( x && typeof x === 'object' && x.getElementsByTagName('wp_ajax') ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        parsed.responses = [];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,6 +27,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                var th = jQuery(this), child = jQuery(this.firstChild), response;
</span><span class="cx" style="display: block; padding: 0 10px">                                response = { action: th.attr('action'), what: child.get(0).nodeName, id: child.attr('id'), oldId: child.attr('old_id'), position: child.attr('position') };
</span><span class="cx" style="display: block; padding: 0 10px">                                response.data = jQuery( 'response_data', child ).text();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                successmsg += response.data;
</ins><span class="cx" style="display: block; padding: 0 10px">                                 response.supplemental = {};
</span><span class="cx" style="display: block; padding: 0 10px">                                if ( !jQuery( 'supplemental', child ).children().each( function() {
</span><span class="cx" style="display: block; padding: 0 10px">                                        response.supplemental[this.nodeName] = jQuery(this).text();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,7 +47,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                } ).length ) { response.errors = false; }
</span><span class="cx" style="display: block; padding: 0 10px">                                parsed.responses.push( response );
</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 ( err.length ) { re.html( '<div class="error">' + err + '</div>' ); }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 if ( err.length ) {
+                               re.html( '<div class="error">' + err + '</div>' );
+                               wp.a11y.speak( err );
+                       } else {
+                               re.html( '<div class="updated notice is-dismissible"><p>' + successmsg + '</p></div>');
+                               jQuery(document).trigger( 'wp-updates-notice-added' );
+                               wp.a11y.speak( successmsg );
+                       }
</ins><span class="cx" style="display: block; padding: 0 10px">                         return parsed;
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px">                if ( isNaN(x) ) { return !re.html('<div class="error"><p>' + x + '</p></div>'); }
</span></span></pre></div>
<a id="trunksrcwpadminincludesajaxactionsphp"></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/includes/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php      2021-11-15 22:16:32 UTC (rev 52169)
+++ trunk/src/wp-admin/includes/ajax-actions.php        2021-11-15 22:23:01 UTC (rev 52170)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1102,9 +1102,19 @@
</span><span class="cx" style="display: block; padding: 0 10px">        $wp_list_table->single_row( $tag );
</span><span class="cx" style="display: block; padding: 0 10px">        $parents = ob_get_clean();
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        require ABSPATH . 'wp-admin/includes/edit-tag-messages.php';
+
+       $message = '';
+       if ( isset( $messages[ $tax->name ][1] ) ) {
+               $message = $messages[ $tax->name ][1];
+       } elseif ( isset( $messages['_item'][1] ) ) {
+               $message = $messages['_item'][1];
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         $x->add(
</span><span class="cx" style="display: block; padding: 0 10px">                array(
</span><span class="cx" style="display: block; padding: 0 10px">                        'what'         => 'taxonomy',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                        'data'         => $message,
</ins><span class="cx" style="display: block; padding: 0 10px">                         'supplemental' => compact( 'parents', 'noparents' ),
</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="trunktestsphpunittestsajaxAddTagphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/ajax/AddTag.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/ajax/AddTag.php                         (rev 0)
+++ trunk/tests/phpunit/tests/ajax/AddTag.php   2021-11-15 22:23:01 UTC (rev 52170)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,145 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Admin ajax functions to be tested.
+ */
+require_once ABSPATH . 'wp-admin/includes/ajax-actions.php';
+
+/**
+ * Class for testing ajax add tag functionality.
+ *
+ * @group ajax
+ */
+class Tests_Ajax_AddTag extends WP_Ajax_UnitTestCase {
+
+       /**
+        * @dataProvider data_add_tag
+        *
+        * @ticket 42937
+        *
+        * @param array                 $post_data Data to populate $_POST.
+        * @param string                $expected  Expected response.
+        * @param array|string|callable $callback  Optional. Callback to register to 'term_updated_messages'
+        *                                         filter. Default empty string (no callback).
+        */
+       public function test_add_tag( array $post_data, $expected, $callback = '' ) {
+               $this->_setRole( 'administrator' );
+
+               $_POST                     = $post_data;
+               $_POST['_wpnonce_add-tag'] = wp_create_nonce( 'add-tag' );
+
+               if ( ! empty( $callback ) ) {
+                       add_filter( 'term_updated_messages', $callback );
+               }
+
+               try {
+                       $this->_handleAjax( 'add-tag' );
+               } catch ( WPAjaxDieContinueException $e ) {
+                       unset( $e );
+               }
+
+               $this->assertSame( $expected, (string) $this->get_xml_response_taxonomy()->response_data );
+       }
+
+       /**
+        * Data provider.
+        *
+        * @return array
+        */
+       public function data_add_tag() {
+               return array(
+                       'add a category'                        => array(
+                               'post_data' => array(
+                                       'taxonomy'  => 'category',
+                                       'post_type' => 'post',
+                                       'screen'    => 'edit-category',
+                                       'action'    => 'add-tag',
+                                       'tag-name'  => 'blues',
+                               ),
+                               'expected'  => 'Category added.',
+                       ),
+                       'add a category with message filtering' => array(
+                               'post_data' => array(
+                                       'taxonomy'  => 'category',
+                                       'post_type' => 'post',
+                                       'screen'    => 'edit-category',
+                                       'action'    => 'add-tag',
+                                       'tag-name'  => 'techno',
+                               ),
+                               'expected'  => 'A new category added.',
+                               'callback'  => static function( array $messages ) {
+                                       $messages['category'][1] = 'A new category added.';
+                                       return $messages;
+                               },
+                       ),
+                       'add a post_tag'                        => array(
+                               'post_data' => array(
+                                       'taxonomy'  => 'post_tag',
+                                       'post_type' => 'post',
+                                       'screen'    => 'edit-post_tag',
+                                       'action'    => 'add-tag',
+                                       'tag-name'  => 'Louis Armstrong',
+                               ),
+                               'expected'  => 'Tag added.',
+                       ),
+               );
+       }
+
+       /**
+        * @ticket 42937
+        */
+       public function test_adding_category_without_capability_should_error() {
+               $this->_setRole( 'subscriber' );
+
+               $_POST['taxonomy']         = 'category';
+               $_POST['post_type']        = 'post';
+               $_POST['screen']           = 'edit-category';
+               $_POST['action']           = 'add-tag';
+               $_POST['tag - name']       = 'disco';
+               $_POST['_wpnonce_add-tag'] = wp_create_nonce( 'add-tag' );
+
+               $this->expectException( 'WPAjaxDieStopException' );
+               $this->expectExceptionMessage( '-1' );
+               $this->_handleAjax( 'add-tag' );
+       }
+
+       /**
+        * @ticket 42937
+        */
+       public function test_adding_existing_category_should_error() {
+               $this->_setRole( 'administrator' );
+
+               wp_insert_term( 'testcat', 'category' );
+
+               $_POST = array(
+                       'taxonomy'         => 'category',
+                       'post_type'        => 'post',
+                       'screen'           => 'edit-category',
+                       'action'           => 'add-tag',
+                       'tag-name'         => 'testcat',
+                       '_wpnonce_add-tag' => wp_create_nonce( 'add-tag' ),
+               );
+
+               try {
+                       $this->_handleAjax( 'add-tag' );
+               } catch ( WPAjaxDieContinueException $e ) {
+                       unset( $e );
+               }
+
+               $expected = 'A term with the name provided already exists with this parent.';
+               $this->assertSame( $expected, (string) $this->get_xml_response_taxonomy()->wp_error );
+       }
+
+       /**
+        * Helper method to get the taxonomy's response or error.
+        *
+        * @since 5.9.0
+        *
+        * @return SimpleXMLElement Response or error object.
+        */
+       private function get_xml_response_taxonomy() {
+               $xml = simplexml_load_string( $this->_last_response, 'SimpleXMLElement', LIBXML_NOCDATA );
+
+               return $xml->response->taxonomy;
+       }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/ajax/AddTag.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="svnexecutable"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:executable</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+*
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>

</body>
</html>