<!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>[38644] trunk/src/wp-admin/js/inline-edit-tax.js: Docs: Add documentation for `wp-admin/js/inline-edit-tax.js`.</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/38644">38644</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/38644","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-09-22 18:49:26 +0000 (Thu, 22 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'>Docs: Add documentation for `wp-admin/js/inline-edit-tax.js`.
Props atimmer, boblinthorst.
Fixes <a href="https://core.trac.wordpress.org/ticket/37571">#37571</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjsinlineedittaxjs">trunk/src/wp-admin/js/inline-edit-tax.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjsinlineedittaxjs"></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/inline-edit-tax.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/inline-edit-tax.js 2016-09-22 18:46:34 UTC (rev 38643)
+++ trunk/src/wp-admin/js/inline-edit-tax.js 2016-09-22 18:49:26 UTC (rev 38644)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,10 +1,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /* global inlineEditL10n, ajaxurl */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * This file is used on the term overview page to power quick-editing terms.
+ */
+
</ins><span class="cx" style="display: block; padding: 0 10px"> window.wp = window.wp || {};
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Consists of functions relevant to the inline taxonomy editor.
+ *
+ * @namespace inlineEditTax
+ *
+ * @property {string} type The type of inline edit we are currently on.
+ * @property {string} what The type property with a hash prefixed and a dash
+ * suffixed.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> var inlineEditTax;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> ( function( $, wp ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> inlineEditTax = {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @summary Initializes the inline taxonomy editor.
+ *
+ * Adds event handlers to be able to quick edit.
+ *
+ * @since 2.7.0
+ *
+ * @this inlineEditTax
+ * @memberof inlineEditTax
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> init : function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var t = this, row = $('#inline-edit');
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,40 +42,87 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // prepare the edit row
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * @summary Cancels inline editing when pressing escape inside the inline editor.
+ *
+ * @param {Object} e The keyup event that has been triggered.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> row.keyup( function( e ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 27 = [escape]
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( e.which === 27 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return inlineEditTax.revert();
</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">+ /**
+ * @summary Cancels inline editing when clicking the cancel button.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '.cancel', row ).click( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> return inlineEditTax.revert();
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @summary Saves the inline edits when clicking the save button.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '.save', row ).click( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> return inlineEditTax.save(this);
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @summary Saves the inline edits when pressing enter inside the inline editor.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( 'input, select', row ).keydown( function( e ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 13 = [enter]
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( e.which === 13 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return inlineEditTax.save( this );
</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">+ /**
+ * @summary Saves the inline edits on submitting the inline edit form.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '#posts-filter input[type="submit"]' ).mousedown( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> t.revert();
</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">+ /**
+ * Toggles the quick edit based on if it is currently shown or hidden.
+ *
+ * @since 2.7.0
+ *
+ * @this inlineEditTax
+ * @memberof inlineEditTax
+ *
+ * @param {HTMLElement} el An element within the table row or the table row
+ * itself that we want to quick edit.
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> toggle : function(el) {
</span><span class="cx" style="display: block; padding: 0 10px"> var t = this;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $(t.what+t.getId(el)).css('display') === 'none' ? t.revert() : t.edit(el);
</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">+ /**
+ * Shows the quick editor
+ *
+ * @since 2.7.0
+ *
+ * @this inlineEditTax
+ * @memberof inlineEditTax
+ *
+ * @param {string|HTMLElement} id The ID of the term we want to quick edit or an
+ * element within the table row or the
+ * table row itself.
+ * @returns {boolean} Always returns false.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> edit : function(id) {
</span><span class="cx" style="display: block; padding: 0 10px"> var editRow, rowData, val,
</span><span class="cx" style="display: block; padding: 0 10px"> t = this;
</span><span class="cx" style="display: block; padding: 0 10px"> t.revert();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Makes sure we can pass an HTMLElement as the ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( typeof(id) === 'object' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> id = t.getId(id);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,9 +148,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ /**
+ * @summary Saves the quick edit data.
+ *
+ * Saves the quick edit data to the server and replaces the table row with the
+ * HTML retrieved from the server.
+ *
+ * @since 2.7.0
+ *
+ * @this inlineEditTax
+ * @memberof inlineEditTax
+ *
+ * @param {string|HTMLElement} id The ID of the term we want to quick edit or an
+ * element within the table row or the
+ * table row itself.
+ * @returns {boolean} Always returns false.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> save : function(id) {
</span><span class="cx" style="display: block; padding: 0 10px"> var params, fields, tax = $('input[name="taxonomy"]').val() || '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Makes sure we can pass an HTMLElement as the ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> if( typeof(id) === 'object' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> id = this.getId(id);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -94,8 +184,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> fields = $('#edit-'+id).find(':input').serialize();
</span><span class="cx" style="display: block; padding: 0 10px"> params = fields + '&' + $.param(params);
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // make ajax request
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Do the ajax request to save the data to the server.
</ins><span class="cx" style="display: block; padding: 0 10px"> $.post( ajaxurl, params,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @summary Handles the response from the server.
+ *
+ * Handles the response from the server, replaces the table row with the response
+ * from the server.
+ *
+ * @param {string} r The string with which to replace the table row.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function(r) {
</span><span class="cx" style="display: block; padding: 0 10px"> var row, new_id, option_value,
</span><span class="cx" style="display: block; padding: 0 10px"> $errorSpan = $( '#edit-' + id + ' .inline-edit-save .error' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -128,7 +226,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $errorSpan.html( r ).show();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Some error strings may contain HTML entities (e.g. `“`), let's use the HTML element's text.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Some error strings may contain HTML entities (e.g. `“`), let's use
+ * the HTML element's text.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> wp.a11y.speak( $errorSpan.text() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,10 +238,20 @@
</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">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Prevent submitting the form when pressing Enter on a focused field.
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ /**
+ * Closes the quick edit form.
+ *
+ * @since 2.7.0
+ *
+ * @this inlineEditTax
+ * @memberof inlineEditTax
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> revert : function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var id = $('table.widefat tr.inline-editor').attr('id');
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,16 +259,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $( 'table.widefat .spinner' ).removeClass( 'is-active' );
</span><span class="cx" style="display: block; padding: 0 10px"> $('#'+id).siblings('tr.hidden').addBack().remove();
</span><span class="cx" style="display: block; padding: 0 10px"> id = id.substr( id.lastIndexOf('-') + 1 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Show the taxonomy row and move focus back to the Quick Edit link.
</span><span class="cx" style="display: block; padding: 0 10px"> $( this.what + id ).show().find( '.editinline' ).focus();
</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">+ /**
+ * Retrieves the ID of the term of the element inside the table row.
+ *
+ * @since 2.7.0
+ *
+ * @memberof inlineEditTax
+ *
+ * @param {HTMLElement} o An element within the table row or the table row itself.
+ * @returns {string} The ID of the term based on the element.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> getId : function(o) {
</span><span class="cx" style="display: block; padding: 0 10px"> var id = o.tagName === 'TR' ? o.id : $(o).parents('tr').attr('id'), parts = id.split('-');
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return parts[parts.length - 1];
</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><span class="cx" style="display: block; padding: 0 10px"> $(document).ready(function(){inlineEditTax.init();});
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> })( jQuery, window.wp );
</span></span></pre>
</div>
</div>
</body>
</html>