enmi-conf.org: comparison wp/wp-includes/js/customize-preview.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-includes/js/customize-preview.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 		 *
 		 * @since 4.7.0
 		 * @access private
 		 *
 		 * @param {string} url URL.
-		 * @returns {string} URL with customized state.
+		 * @return {string} URL with customized state.
 		 */
 		injectUrlWithState = function( url ) {
 			var urlParser, oldQueryParams, newQueryParams;
 			urlParser = document.createElement( 'a' );
 			urlParser.href = url;
 	 * @augments wp.customize.Class
 	 * @mixes wp.customize.Events
 	 */
 	api.Preview = api.Messenger.extend(/** @lends wp.customize.Preview.prototype */{
 		/**
-		 * @param {object} params  - Parameters to configure the messenger.
+		 * @param {Object} params  - Parameters to configure the messenger.
-		 * @param {object} options - Extend any instance parameter or method with this object.
+		 * @param {Object} options - Extend any instance parameter or method with this object.
 		 */
 		initialize: function( params, options ) {
 			var preview = this, urlParser = document.createElement( 'a' );
 			api.Messenger.prototype.initialize.call( preview, params, options );
 	/**
 	 * Inject the changeset UUID into links in the document.
 	 *
 	 * @since 4.7.0
 	 * @access protected
-	 *
 	 * @access private
-	 * @returns {void}
+	 *
+	 * @return {void}
 	 */
 	api.addLinkPreviewing = function addLinkPreviewing() {
 		var linkSelectors = 'a[href], area[href]';
 		// Inject links into initial document.
 	 *
 	 * @param {HTMLAnchorElement|HTMLAreaElement} element Link element.
 	 * @param {string} element.search Query string.
 	 * @param {string} element.pathname Path.
 	 * @param {string} element.host Host.
-	 * @param {object} [options]
+	 * @param {Object} [options]
-	 * @param {object} [options.allowAdminAjax=false] Allow admin-ajax.php requests.
+	 * @param {Object} [options.allowAdminAjax=false] Allow admin-ajax.php requests.
-	 * @returns {boolean} Is appropriate for changeset link.
+	 * @return {boolean} Is appropriate for changeset link.
 	 */
 	api.isLinkPreviewable = function isLinkPreviewable( element, options ) {
 		var matchesAllowedUrl, parsedAllowedUrl, args, elementHost;
 		args = _.extend( {}, { allowAdminAjax: false }, options || {} );
 	 *
 	 * @param {HTMLAnchorElement|HTMLAreaElement} element Link element.
 	 * @param {string} element.search Query string.
 	 * @param {string} element.host Host.
 	 * @param {string} element.protocol Protocol.
-	 * @returns {void}
+	 * @return {void}
 	 */
 	api.prepareLinkPreview = function prepareLinkPreview( element ) {
 		var queryParams, $element = $( element );
-// Skip elements with no href attribute. Check first to avoid more expensive checks down the road
+// Skip elements with no href attribute. Check first to avoid more expensive checks down the road.
 if ( ! element.hasAttribute( 'href' ) ) {
 return;
 }
 		// Skip links in admin bar.
 		// Make sure links in preview use HTTPS if parent frame uses HTTPS.
 		if ( api.settings.channel && 'https' === api.preview.scheme.get() && 'http:' === element.protocol && -1 !== api.settings.url.allowedHosts.indexOf( element.host ) ) {
 			element.protocol = 'https:';
 		}
-		// Ignore links with class wp-playlist-caption
+		// Ignore links with class wp-playlist-caption.
 		if ( $element.hasClass( 'wp-playlist-caption' ) ) {
 			return;
 		}
 		if ( ! api.isLinkPreviewable( element ) ) {
 	api.addRequestPreviewing = function addRequestPreviewing() {
 		/**
 		 * Rewrite Ajax requests to inject customizer state.
 		 *
-		 * @param {object} options Options.
+		 * @param {Object} options Options.
 		 * @param {string} options.type Type.
 		 * @param {string} options.url URL.
-		 * @param {object} originalOptions Original options.
+		 * @param {Object} originalOptions Original options.
 		 * @param {XMLHttpRequest} xhr XHR.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		var prefilterAjax = function( options, originalOptions, xhr ) {
 			var urlParser, queryParams, requestMethod, dirtyValues = {};
 			urlParser = document.createElement( 'a' );
 			urlParser.href = options.url;
 	 * Inject changeset UUID into forms, allowing preview to persist through submissions.
 	 *
 	 * @since 4.7.0
 	 * @access protected
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	api.addFormPreviewing = function addFormPreviewing() {
 		// Inject inputs for forms in initial document.
 		$( document.body ).find( 'form' ).each( function() {
 	 *
 	 * @since 4.7.0
 	 * @access protected
 	 *
 	 * @param {HTMLFormElement} form Form.
-	 * @returns {void}
+	 * @return {void}
 	 */
 	api.prepareFormPreview = function prepareFormPreview( form ) {
 		var urlParser, stateParams = {};
 		if ( ! form.action ) {
 		/**
 		 * Preview changes to custom logo.
 		 *
 		 * @param {number} attachmentId Attachment ID for custom logo.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		custom_logo: function( attachmentId ) {
 			$( 'body' ).toggleClass( 'wp-custom-logo', !! attachmentId );
 		},
 		/**
 		 * Preview changes to custom css.
 		 *
 		 * @param {string} value Custom CSS..
-		 * @returns {void}
+		 * @return {void}
 		 */
 		custom_css: function( value ) {
 			$( '#wp-custom-css' ).text( value );
 		},
 		/**
 		 * Preview changes to any of the background settings.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		background: function() {
 			var css = '', settings = {};
 			_.each( ['color', 'image', 'preset', 'position_x', 'position_y', 'size', 'repeat', 'attachment'], function( prop ) {
 		/**
 		 * Handle update to changeset UUID.
 		 *
 		 * @param {string} uuid - UUID.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		handleUpdatedChangesetUuid = function( uuid ) {
 			api.settings.changeset.uuid = uuid;
 			// Update UUIDs in links and forms.

enmi-conf.org