diff --git a/src/wp-admin/js/tags.js b/src/wp-admin/js/tags.js index fc923f1f8d..c35efaa177 100644 --- a/src/wp-admin/js/tags.js +++ b/src/wp-admin/js/tags.js @@ -1,50 +1,113 @@ /* global ajaxurl, wpAjax, tagsl10n, showNotice, validateForm */ +/** + * Contains logic for both adding and deleting tags. For deleting tags it makes a request + * to the server to delete the tag. For adding tags it makes a request to the server to + * add the tag. + * + * @summary Contains logic for deleting and adding tags + */ jQuery(document).ready(function($) { + /** + * @summary Adds an event handler to the delete term link on the term overview page. + * + * Adds an event handler to the delete term link on the term overview page. + * Cancels default event handling and event bubbling. + * + * @since 2.8.0 + * + * @returns boolean Always returns false to cancel the default event handling. + */ $( '#the-list' ).on( 'click', '.delete-tag', function() { var t = $(this), tr = t.parents('tr'), r = true, data; + if ( 'undefined' != showNotice ) r = showNotice.warn(); + if ( r ) { data = t.attr('href').replace(/[^?]*\?/, '').replace(/action=delete/, 'action=delete-tag'); + + /** + * @summary Makes a request to the server to delete the term that + * corresponds to the delete term button. + * + * @param {string} r The response from the server. + * + * @returns {void} + */ $.post(ajaxurl, data, function(r){ if ( '1' == r ) { $('#ajax-response').empty(); tr.fadeOut('normal', function(){ tr.remove(); }); - // Remove the term from the parent box and tag cloud + + /** + * @summary Remove the term from the parent box and the tag cloud + * + * `data.match(/tag_ID=(\d+)/)[1]` matches the term id from the data variable. + * This term id is then used to select the relevant HTML elements: + * The parent box and the tag cloud. + */ $('select#parent option[value="' + data.match(/tag_ID=(\d+)/)[1] + '"]').remove(); $('a.tag-link-' + data.match(/tag_ID=(\d+)/)[1]).remove(); + } else if ( '-1' == r ) { $('#ajax-response').empty().append('

' + tagsl10n.noPerm + '

'); tr.children().css('backgroundColor', ''); + } else { $('#ajax-response').empty().append('

' + tagsl10n.broken + '

'); tr.children().css('backgroundColor', ''); } }); + tr.children().css('backgroundColor', '#f33'); } + return false; }); + /** + * Adds a deletion confirmation when removing a tag. + * + * @since 4.8.0 + * + * @returns {void} + */ $( '#edittag' ).on( 'click', '.delete', function( e ) { if ( 'undefined' === typeof showNotice ) { return true; } + // Confirms the deletion, a negative response means the deletion must not be executed. var response = showNotice.warn(); if ( ! response ) { e.preventDefault(); } }); + /** + * @summary Adds an event handler tot he form submit on the term overview page. + * + * Cancels default event handling and event bubbling. + * + * @since 2.8.0 + * + * @returns boolean Always returns false to cancel the default event handling. + */ $('#submit').click(function(){ var form = $(this).parents('form'); if ( ! validateForm( form ) ) return false; + /** + * Does a request to the server to add a new term to the database + * + * @param {string} r The response from the server. + * + * @returns {void} + */ $.post(ajaxurl, $('#addtag').serialize(), function(r){ var res, parent, term, indent, i;