<!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>[42614] trunk/src: Taxonomy: Use REST API for ajax tag search.</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/42614">42614</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/42614","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-01-30 00:16:37 +0000 (Tue, 30 Jan 2018)</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: Use REST API for ajax tag search.
Deprecate wp_ajax_ajax_tag_search and switch to using the REST API when searching tags in the tags meta box.
Props nacin, chriscct7, afercia, swissspidy, jnylen0, rmccue, ryelle.
Fixes <a href="https://core.trac.wordpress.org/ticket/38922">#38922</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
<li><a href="#trunksrcwpadminincludesdeprecatedphp">trunk/src/wp-admin/includes/deprecated.php</a></li>
<li><a href="#trunksrcwpadminjstagssuggestjs">trunk/src/wp-admin/js/tags-suggest.js</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2018-01-29 23:55:44 UTC (rev 42613)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2018-01-30 00:16:37 UTC (rev 42614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,69 +100,6 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Ajax handler for tag search.
- *
- * @since 3.1.0
- */
-function wp_ajax_ajax_tag_search() {
- if ( ! isset( $_GET['tax'] ) ) {
- wp_die( 0 );
- }
-
- $taxonomy = sanitize_key( $_GET['tax'] );
- $tax = get_taxonomy( $taxonomy );
- if ( ! $tax ) {
- wp_die( 0 );
- }
-
- if ( ! current_user_can( $tax->cap->assign_terms ) ) {
- wp_die( -1 );
- }
-
- $s = wp_unslash( $_GET['q'] );
-
- $comma = _x( ',', 'tag delimiter' );
- if ( ',' !== $comma ) {
- $s = str_replace( $comma, ',', $s );
- }
- if ( false !== strpos( $s, ',' ) ) {
- $s = explode( ',', $s );
- $s = $s[ count( $s ) - 1 ];
- }
- $s = trim( $s );
-
- /**
- * Filters the minimum number of characters required to fire a tag search via Ajax.
- *
- * @since 4.0.0
- *
- * @param int $characters The minimum number of characters required. Default 2.
- * @param WP_Taxonomy $tax The taxonomy object.
- * @param string $s The search term.
- */
- $term_search_min_chars = (int) apply_filters( 'term_search_min_chars', 2, $tax, $s );
-
- /*
- * Require $term_search_min_chars chars for matching (default: 2)
- * ensure it's a non-negative, non-zero integer.
- */
- if ( ( $term_search_min_chars == 0 ) || ( strlen( $s ) < $term_search_min_chars ) ) {
- wp_die();
- }
-
- $results = get_terms(
- $taxonomy, array(
- 'name__like' => $s,
- 'fields' => 'names',
- 'hide_empty' => false,
- )
- );
-
- echo join( $results, "\n" );
- wp_die();
-}
-
-/**
</del><span class="cx" style="display: block; padding: 0 10px"> * Ajax handler for compression testing.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span></span></pre></div>
<a id="trunksrcwpadminincludesdeprecatedphp"></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/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/deprecated.php 2018-01-29 23:55:44 UTC (rev 42613)
+++ trunk/src/wp-admin/includes/deprecated.php 2018-01-30 00:16:37 UTC (rev 42614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1514,3 +1514,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </script>
</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">+
+/**
+ * Ajax handler for tag search.
+ *
+ * @since 3.1.0
+ * @deprecated 4.9.0 Use the REST API tags endpoint instead.
+ */
+function wp_ajax_ajax_tag_search() {
+ _deprecated_function( __FUNCTION__, '4.8', '/wp-json/wp/v2/tags' );
+
+ if ( ! isset( $_GET['tax'] ) ) {
+ wp_die( 0 );
+ }
+
+ $taxonomy = sanitize_key( $_GET['tax'] );
+ $tax = get_taxonomy( $taxonomy );
+ if ( ! $tax ) {
+ wp_die( 0 );
+ }
+
+ if ( ! current_user_can( $tax->cap->assign_terms ) ) {
+ wp_die( -1 );
+ }
+
+ $s = wp_unslash( $_GET['q'] );
+
+ $comma = _x( ',', 'tag delimiter' );
+ if ( ',' !== $comma ) {
+ $s = str_replace( $comma, ',', $s );
+ }
+ if ( false !== strpos( $s, ',' ) ) {
+ $s = explode( ',', $s );
+ $s = $s[ count( $s ) - 1 ];
+ }
+ $s = trim( $s );
+
+ /** This filter is documented in wp-includes/script-loader.php */
+ $term_search_min_chars = (int) apply_filters( 'term_search_min_chars', 2, $tax, $s );
+
+ /*
+ * Require $term_search_min_chars chars for matching (default: 2)
+ * ensure it's a non-negative, non-zero integer.
+ */
+ if ( ( $term_search_min_chars == 0 ) || ( strlen( $s ) < $term_search_min_chars ) ) {
+ wp_die();
+ }
+
+ $results = get_terms(
+ $taxonomy, array(
+ 'name__like' => $s,
+ 'fields' => 'names',
+ 'hide_empty' => false,
+ )
+ );
+
+ echo join( $results, "\n" );
+ wp_die();
+}
</ins></span></pre></div>
<a id="trunksrcwpadminjstagssuggestjs"></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/tags-suggest.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/tags-suggest.js 2018-01-29 23:55:44 UTC (rev 42613)
+++ trunk/src/wp-admin/js/tags-suggest.js 2018-01-30 00:16:37 UTC (rev 42614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,33 +53,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> term = getLast( request.term );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $.get( window.ajaxurl, {
- action: 'ajax-tag-search',
- tax: taxonomy,
- q: term
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $.get( window.tagsSuggestL10n.restURL, {
+ _fields: [ 'id', 'name' ],
+ taxonomy: taxonomy,
+ search: term
</ins><span class="cx" style="display: block; padding: 0 10px"> } ).always( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $element.removeClass( 'ui-autocomplete-loading' ); // UI fails to remove this sometimes?
</span><span class="cx" style="display: block; padding: 0 10px"> } ).done( function( data ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var tagName;
- var tags = [];
-
- if ( data ) {
- data = data.split( '\n' );
-
- for ( tagName in data ) {
- var id = ++tempID;
-
- tags.push({
- id: id,
- name: data[tagName]
- });
- }
-
- cache = tags;
- response( tags );
- } else {
- response( tags );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ cache = data;
+ response( data );
</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"> last = request.term;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,7 +100,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> close: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $element.attr( 'aria-expanded', 'false' );
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- minLength: 2,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ minLength: window.tagsSuggestL10n.minChars,
</ins><span class="cx" style="display: block; padding: 0 10px"> position: {
</span><span class="cx" style="display: block; padding: 0 10px"> my: 'left top+2',
</span><span class="cx" style="display: block; padding: 0 10px"> at: 'left bottom',
</span></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></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/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2018-01-29 23:55:44 UTC (rev 42613)
+++ trunk/src/wp-includes/script-loader.php 2018-01-30 00:16:37 UTC (rev 42614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -726,6 +726,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'termSelected' => __( 'Term selected.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'termAdded' => __( 'Term added.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'termRemoved' => __( 'Term removed.' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'restURL' => rest_url( '/wp/v2/tags' ),
+
+ /**
+ * Filters the minimum number of characters required to fire a tag search via Ajax.
+ *
+ * Previous to 4.8.0, this filter passed taxonomy and search context parameters.
+ * @since 4.0.0
+ *
+ * @param int $characters The minimum number of characters required. Default 2.
+ */
+ 'minChars' => (int) apply_filters( 'term_search_min_chars', 2 ),
</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>