enmi-conf.org: comparison wp/wp-admin/js/inline-edit-post.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-admin/js/inline-edit-post.js

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 /* global inlineEditL10n, ajaxurl, typenow */
+/**
+* This file contains the functions needed for the inline editing of posts.
+*
+* @since 2.7.0
+*/
+window.wp = window.wp || {};
+/**
+* Manages the quick edit and bulk edit windows for editing posts or pages.
+*
+* @namespace
+*
+* @since 2.7.0
+* @access public
+*
+* @type {Object}
+*
+* @property {string} type The type of inline editor.
+* @property {string} what The prefix before the post id.
+*
+*/
 var inlineEditPost;
-(function($) {
+( function( $, wp ) {
-inlineEditPost = {
+	inlineEditPost = {
+	/**
+	 * @summary Initializes the inline and bulk post editor.
+	 *
+	 * Binds event handlers to the escape key to close the inline editor
+	 * and to the save and close buttons. Changes DOM to be ready for inline
+	 * editing. Adds event handler to bulk edit.
+	 *
+	 * @memberof inlineEditPost
+	 * @since 2.7.0
+	 *
+	 * @returns {void}
+	 */
 	init : function(){
 		var t = this, qeRow = $('#inline-edit'), bulkRow = $('#bulk-edit');
 		t.type = $('table.widefat').hasClass('pages') ? 'page' : 'post';
+		// Post id prefix.
 		t.what = '#post-';
-		// prepare the edit rows
+		/**
+		 * @summary Bind escape key to revert the changes and close the quick editor.
+		 *
+		 * @returns {boolean} The result of revert.
+		 */
 		qeRow.keyup(function(e){
+			// Revert changes if escape key is pressed.
 			if ( e.which === 27 ) {
 				return inlineEditPost.revert();
 			}
 		});
+		/**
+		 * @summary Bind escape key to revert the changes and close the bulk editor.
+		 *
+		 * @returns {boolean} The result of revert.
+		 */
 		bulkRow.keyup(function(e){
+			// Revert changes if escape key is pressed.
 			if ( e.which === 27 ) {
 				return inlineEditPost.revert();
 			}
 		});
-		$('a.cancel', qeRow).click(function(){
+		/**
+		 * @summary Revert changes and close the quick editor if the cancel button is clicked.
+		 *
+		 * @returns {boolean} The result of revert.
+		 */
+		$( '.cancel', qeRow ).click( function() {
 			return inlineEditPost.revert();
 		});
-		$('a.save', qeRow).click(function(){
+		/**
+		 * @summary Save changes in the quick editor if the save(named: update) button is clicked.
+		 *
+		 * @returns {boolean} The result of save.
+		 */
+		$( '.save', qeRow ).click( function() {
 			return inlineEditPost.save(this);
 		});
+		/**
+		 * @summary If enter is pressed, and the target is not the cancel button, save the post.
+		 *
+		 * @returns {boolean} The result of save.
+		 */
 		$('td', qeRow).keydown(function(e){
 			if ( e.which === 13 && ! $( e.target ).hasClass( 'cancel' ) ) {
 				return inlineEditPost.save(this);
 			}
 		});
-		$('a.cancel', bulkRow).click(function(){
+		/**
+		 * @summary Revert changes and close the bulk editor if the cancel button is clicked.
+		 *
+		 * @returns {boolean} The result of revert.
+		 */
+		$( '.cancel', bulkRow ).click( function() {
 			return inlineEditPost.revert();
 		});
+		/**
+		 * @summary Disables the password input field when the private post checkbox is checked.
+		 */
 		$('#inline-edit .inline-edit-private input[value="private"]').click( function(){
 			var pw = $('input.inline-edit-password-input');
 			if ( $(this).prop('checked') ) {
 				pw.val('').prop('disabled', true);
 			} else {
 				pw.prop('disabled', false);
 			}
 		});
-		// add events
+		/**
-		$('#the-list').on('click', 'a.editinline', function(){
+		 * @summary Bind click event to the .editinline link which opens the quick editor.
+		 */
+		$('#the-list').on( 'click', 'a.editinline', function( e ) {
+			e.preventDefault();
 			inlineEditPost.edit(this);
-			return false;
 		});
 		$('#bulk-edit').find('fieldset:first').after(
 			$('#inline-edit fieldset.inline-edit-categories').clone()
 		).siblings( 'fieldset:last' ).prepend(
 			$('#inline-edit label.inline-edit-tags').clone()
 		);
 		$('select[name="_status"] option[value="future"]', bulkRow).remove();
+		/**
+		 * @summary Adds onclick events to the apply buttons.
+		 */
 		$('#doaction, #doaction2').click(function(e){
-			var n = $(this).attr('id').substr(2);
+			var n;
+			t.whichBulkButtonId = $( this ).attr( 'id' );
+			n = t.whichBulkButtonId.substr( 2 );
 			if ( 'edit' === $( 'select[name="' + n + '"]' ).val() ) {
 				e.preventDefault();
 				t.setBulk();
 			} else if ( $('form#posts-filter tr.inline-editor').length > 0 ) {
 				t.revert();
 			}
 		});
 	},
+	/**
+	 * @summary Toggles the quick edit window.
+	 *
+	 * Hides the window when it's active and shows the window when inactive.
+	 *
+	 * @memberof inlineEditPost
+	 * @since 2.7.0
+	 *
+	 * @param {Object} el Element within a post table row.
+	 */
 	toggle : function(el){
 		var t = this;
 		$( t.what + t.getId( el ) ).css( 'display' ) === 'none' ? t.revert() : t.edit( el );
 	},
+	/**
+	 * @summary Creates the bulk editor row to edit multiple posts at once.
+	 *
+	 * @memberof inlineEditPost
+	 * @since 2.7.0
+	 */
 	setBulk : function(){
-		var te = '', type = this.type, tax, c = true;
+		var te = '', type = this.type, c = true;
 		this.revert();
-		$('#bulk-edit td').attr('colspan', $('.widefat:first thead th:visible').length);
+		$( '#bulk-edit td' ).attr( 'colspan', $( 'th:visible, td:visible', '.widefat:first thead' ).length );
 		// Insert the editor at the top of the table with an empty row above to maintain zebra striping.
 		$('table.widefat tbody').prepend( $('#bulk-edit') ).prepend('<tr class="hidden"></tr>');
 		$('#bulk-edit').addClass('inline-editor').show();
+		/**
+		 * @summary Create a HTML div with the title and a delete link(cross-icon) for each selected post.
+		 *
+		 * Get the selected posts based on the checked checkboxes in the post table.
+		 * Create a HTML div with the title and a link(delete-icon) for each selected post.
+		 */
 		$( 'tbody th.check-column input[type="checkbox"]' ).each( function() {
+			// If the checkbox for a post is selected, add the post to the edit list.
 			if ( $(this).prop('checked') ) {
 				c = false;
 				var id = $(this).val(), theTitle;
 				theTitle = $('#inline_'+id+' .post_title').html() || inlineEditL10n.notitle;
 				te += '<div id="ttle'+id+'"><a id="_'+id+'" class="ntdelbutton" title="'+inlineEditL10n.ntdeltitle+'">X</a>'+theTitle+'</div>';
 			}
 		});
+		// If no checkboxes where checked, just hide the quick/bulk edit rows.
 		if ( c ) {
 			return this.revert();
 		}
+		// Add onclick events to the delete-icons in the bulk editors the post title list.
 		$('#bulk-titles').html(te);
+		/**
+		 * @summary Binds on click events to the checkboxes before the posts in the table.
+		 *
+		 * @listens click
+		 */
 		$('#bulk-titles a').click(function(){
 			var id = $(this).attr('id').substr(1);
 			$('table.widefat input[value="' + id + '"]').prop('checked', false);
 			$('#ttle'+id).remove();
 		});
-		// enable autocomplete for tags
+		// Enable auto-complete for tags when editing posts.
 		if ( 'post' === type ) {
-			// support multi taxonomies?
+			$( 'tr.inline-editor textarea[data-wp-taxonomy]' ).each( function ( i, element ) {
-			tax = 'post_tag';
+				/*
-			$('tr.inline-editor textarea[name="tax_input['+tax+']"]').suggest( ajaxurl + '?action=ajax-tag-search&tax=' + tax, { delay: 500, minchars: 2, multiple: true, multipleSep: inlineEditL10n.comma } );
+				 * While Quick Edit clones the form each time, Bulk Edit always re-uses
-		}
+				 * the same form. Let's check if an autocomplete instance already exists.
+				 */
+				if ( $( element ).autocomplete( 'instance' ) ) {
+					// jQuery equivalent of `continue` within an `each()` loop.
+					return;
+				}
+				$( element ).wpTagsSuggest();
+			} );
+		}
+		// Scrolls to the top of the table where the editor is rendered.
 		$('html, body').animate( { scrollTop: 0 }, 'fast' );
 	},
+	/**
+	 * @summary Creates a quick edit window for the post that has been clicked.
+	 *
+	 * @memberof inlineEditPost
+	 * @since 2.7.0
+	 *
+	 * @param {number|Object} id The id of the clicked post or an element within a post
+	 *                           table row.
+	 * @returns {boolean} Always returns false at the end of execution.
+	 */
 	edit : function(id) {
-		var t = this, fields, editRow, rowData, status, pageOpt, pageLevel, nextPage, pageLoop = true, nextLevel, cur_format, f, val;
+		var t = this, fields, editRow, rowData, status, pageOpt, pageLevel, nextPage, pageLoop = true, nextLevel, f, val, pw;
 		t.revert();
 		if ( typeof(id) === 'object' ) {
 			id = t.getId(id);
 		}
-		fields = ['post_title', 'post_name', 'post_author', '_status', 'jj', 'mm', 'aa', 'hh', 'mn', 'ss', 'post_password', 'post_format', 'menu_order'];
+		fields = ['post_title', 'post_name', 'post_author', '_status', 'jj', 'mm', 'aa', 'hh', 'mn', 'ss', 'post_password', 'post_format', 'menu_order', 'page_template'];
 		if ( t.type === 'page' ) {
-			fields.push('post_parent', 'page_template');
+			fields.push('post_parent');
 		}
-		// add the new edit row with an extra blank row underneath to maintain zebra striping.
+		// Add the new edit row with an extra blank row underneath to maintain zebra striping.
 		editRow = $('#inline-edit').clone(true);
-		$('td', editRow).attr('colspan', $('.widefat:first thead th:visible').length);
+		$( 'td', editRow ).attr( 'colspan', $( 'th:visible, td:visible', '.widefat:first thead' ).length );
-		$(t.what+id).hide().after(editRow).after('<tr class="hidden"></tr>');
+		$(t.what+id).removeClass('is-expanded').hide().after(editRow).after('<tr class="hidden"></tr>');
-		// populate the data
+		// Populate fields in the quick edit window.
 		rowData = $('#inline_'+id);
 		if ( !$(':input[name="post_author"] option[value="' + $('.post_author', rowData).text() + '"]', editRow).val() ) {
-			// author no longer has edit caps, so we need to add them to the list of authors
+			// The post author no longer has edit capabilities, so we need to add them to the list of authors.
 			$(':input[name="post_author"]', editRow).prepend('<option value="' + $('.post_author', rowData).text() + '">' + $('#' + t.type + '-' + id + ' .author').text() + '</option>');
 		}
 		if ( $( ':input[name="post_author"] option', editRow ).length === 1 ) {
 			$('label.inline-edit-author', editRow).hide();
 		}
-		// hide unsupported formats, but leave the current format alone
-		cur_format = $('.post_format', rowData).text();
-		$('option.unsupported', editRow).each(function() {
-			var $this = $(this);
-			if ( $this.val() !== cur_format ) {
-				$this.remove();
-			}
-		});
 		for ( f = 0; f < fields.length; f++ ) {
 			val = $('.'+fields[f], rowData);
-			// Deal with Twemoji
+			/**
+			 * @summary Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
+			 *
+			 * @returns Alternate text from the image.
+			 */
 			val.find( 'img' ).replaceWith( function() { return this.alt; } );
 			val = val.text();
 			$(':input[name="' + fields[f] + '"]', editRow).val( val );
 		}
 		}
 		if ( $( '.sticky', rowData ).text() === 'sticky' ) {
 			$( 'input[name="sticky"]', editRow ).prop( 'checked', true );
 		}
-		// hierarchical taxonomies
+		/**
+		 * @summary Creates the select boxes for the categories.
+		 */
 		$('.post_category', rowData).each(function(){
 			var taxname,
 				term_ids = $(this).text();
 			if ( term_ids ) {
 				taxname = $(this).attr('id').replace('_'+id, '');
 				$('ul.'+taxname+'-checklist :checkbox', editRow).val(term_ids.split(','));
 			}
 		});
-		//flat taxonomies
+		/**
+		 * @summary Gets all the taxonomies for live auto-fill suggestions.
+		 * When typing the name of a tag.
+		 */
 		$('.tags_input', rowData).each(function(){
 			var terms = $(this),
 				taxname = $(this).attr('id').replace('_' + id, ''),
 				textarea = $('textarea.tax_input_' + taxname, editRow),
 				comma = inlineEditL10n.comma;
 					terms = terms.replace(/,/g, comma);
 				}
 				textarea.val(terms);
 			}
-			textarea.suggest( ajaxurl + '?action=ajax-tag-search&tax=' + taxname, { delay: 500, minchars: 2, multiple: true, multipleSep: inlineEditL10n.comma } );
+			textarea.wpTagsSuggest();
 		});
-		// handle the post status
+		// Handle the post status.
 		status = $('._status', rowData).text();
 		if ( 'future' !== status ) {
 			$('select[name="_status"] option[value="future"]', editRow).remove();
 		}
+		pw = $( '.inline-edit-password-input' ).prop( 'disabled', false );
 		if ( 'private' === status ) {
 			$('input[name="keep_private"]', editRow).prop('checked', true);
-			$('input.inline-edit-password-input').val('').prop('disabled', true);
+			pw.val( '' ).prop( 'disabled', true );
 		}
-		// remove the current page and children from the parent dropdown
+		// Remove the current page and children from the parent dropdown.
 		pageOpt = $('select[name="post_parent"] option[value="' + id + '"]', editRow);
 		if ( pageOpt.length > 0 ) {
 			pageLevel = pageOpt[0].className.split('-')[1];
 			nextPage = pageOpt;
 			while ( pageLoop ) {
 		$('.ptitle', editRow).focus();
 		return false;
 	},
+	/**
+	 * @summary Saves the changes made in the quick edit window to the post.
+	 * AJAX saving is only for Quick Edit and not for bulk edit.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @param   {int}     id The id for the post that has been changed.
+	 * @returns {boolean}    false, so the form does not submit when pressing
+	 *                       Enter on a focused field.
+	 */
 	save : function(id) {
 		var params, fields, page = $('.post_status_page').val() || '';
 		if ( typeof(id) === 'object' ) {
 			id = this.getId(id);
 		};
 		fields = $('#edit-'+id).find(':input').serialize();
 		params = fields + '&' + $.param(params);
-		// make ajax request
+		// Make ajax request.
 		$.post( ajaxurl, params,
 			function(r) {
+				var $errorNotice = $( '#edit-' + id + ' .inline-edit-save .notice-error' ),
+					$error = $errorNotice.find( '.error' );
 				$( 'table.widefat .spinner' ).removeClass( 'is-active' );
+				$( '.ac_results' ).hide();
 				if (r) {
 					if ( -1 !== r.indexOf( '<tr' ) ) {
 						$(inlineEditPost.what+id).siblings('tr.hidden').addBack().remove();
 						$('#edit-'+id).before(r).remove();
-						$(inlineEditPost.what+id).hide().fadeIn();
+						$( inlineEditPost.what + id ).hide().fadeIn( 400, function() {
+							// Move focus back to the Quick Edit link. $( this ) is the row being animated.
+							$( this ).find( '.editinline' ).focus();
+							wp.a11y.speak( inlineEditL10n.saved );
+						});
 					} else {
 						r = r.replace( /<.[^<>]*?>/g, '' );
-						$('#edit-'+id+' .inline-edit-save .error').html(r).show();
+						$errorNotice.removeClass( 'hidden' );
+						$error.html( r );
+						wp.a11y.speak( $error.text() );
 					}
 				} else {
-					$('#edit-'+id+' .inline-edit-save .error').html(inlineEditL10n.error).show();
+					$errorNotice.removeClass( 'hidden' );
+					$error.html( inlineEditL10n.error );
+					wp.a11y.speak( inlineEditL10n.error );
 				}
 			},
 		'html');
+		// Prevent submitting the form when pressing Enter on a focused field.
 		return false;
 	},
+	/**
+	 * @summary Hides and empties the Quick Edit and/or Bulk Edit windows.
+	 *
+	 * @memberof    inlineEditPost
+	 * @since 2.7.0
+	 *
+	 * @returns {boolean} Always returns false.
+	 */
 	revert : function(){
-		var id = $('table.widefat tr.inline-editor').attr('id');
+		var $tableWideFat = $( '.widefat' ),
+			id = $( '.inline-editor', $tableWideFat ).attr( 'id' );
 		if ( id ) {
-			$( 'table.widefat .spinner' ).removeClass( 'is-active' );
+			$( '.spinner', $tableWideFat ).removeClass( 'is-active' );
+			$( '.ac_results' ).hide();
 			if ( 'bulk-edit' === id ) {
-				$('table.widefat #bulk-edit').removeClass('inline-editor').hide().siblings('tr.hidden').remove();
+				// Hide the bulk editor.
+				$( '#bulk-edit', $tableWideFat ).removeClass( 'inline-editor' ).hide().siblings( '.hidden' ).remove();
 				$('#bulk-titles').empty();
+				// Store the empty bulk editor in a hidden element.
 				$('#inlineedit').append( $('#bulk-edit') );
+				// Move focus back to the Bulk Action button that was activated.
+				$( '#' + inlineEditPost.whichBulkButtonId ).focus();
 			} else {
+				// Remove both the inline-editor and its hidden tr siblings.
 				$('#'+id).siblings('tr.hidden').addBack().remove();
 				id = id.substr( id.lastIndexOf('-') + 1 );
-				$(this.what+id).show();
+				// Show the post row and move focus back to the Quick Edit link.
+				$( this.what + id ).show().find( '.editinline' ).focus();
 			}
 		}
 		return false;
 	},
+	/**
+	 * @summary Gets the id for a the post that you want to quick edit from the row
+	 * in the quick edit table.
+	 *
+	 * @memberof    inlineEditPost
+	 * @since 2.7.0
+	 *
+	 * @param   {Object} o DOM row object to get the id for.
+	 * @returns {string}   The post id extracted from the table row in the object.
+	 */
 	getId : function(o) {
 		var id = $(o).closest('tr').attr('id'),
 			parts = id.split('-');
 		return parts[parts.length - 1];
 	}
 };
 $( document ).ready( function(){ inlineEditPost.init(); } );
-// Show/hide locks on posts
+// Show/hide locks on posts.
 $( document ).on( 'heartbeat-tick.wp-check-locked-posts', function( e, data ) {
 	var locked = data['wp-check-locked-posts'] || {};
 	$('#the-list tr').each( function(i, el) {
 		var key = el.id, row = $(el), lock_data, avatar;
 				lock_data = locked[key];
 				row.find('.column-title .locked-text').text( lock_data.text );
 				row.find('.check-column checkbox').prop('checked', false);
 				if ( lock_data.avatar_src ) {
-					avatar = $('<img class="avatar avatar-18 photo" width="18" height="18" />').attr( 'src', lock_data.avatar_src.replace(/&amp;/g, '&') );
+					avatar = $( '<img class="avatar avatar-18 photo" width="18" height="18" alt="" />' ).attr( 'src', lock_data.avatar_src.replace( /&amp;/g, '&' ) );
 					row.find('.column-title .locked-avatar').empty().append( avatar );
 				}
 				row.addClass('wp-locked');
 			}
 		} else if ( row.hasClass('wp-locked') ) {
 	if ( check.length ) {
 		data['wp-check-locked-posts'] = check;
 	}
 }).ready( function() {
 	// Set the heartbeat interval to 15 sec.
 	if ( typeof wp !== 'undefined' && wp.heartbeat ) {
 		wp.heartbeat.interval( 15 );
 	}
 });
-}(jQuery));
+})( jQuery, window.wp );

enmi-conf.org