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

changeset 16	a86126ab1dd4
parent 9	177826044cd9

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 */
 window.wp = window.wp || {};
 (function(){
 	wp.shortcode = {
-		// ### Find the next matching shortcode
+		/*
-		//
+		 * ### Find the next matching shortcode.
-		// Given a shortcode `tag`, a block of `text`, and an optional starting
+		 *
-		// `index`, returns the next matching shortcode or `undefined`.
+		 * Given a shortcode `tag`, a block of `text`, and an optional starting
-		//
+		 * `index`, returns the next matching shortcode or `undefined`.
-		// Shortcodes are formatted as an object that contains the match
+		 *
-		// `content`, the matching `index`, and the parsed `shortcode` object.
+		 * Shortcodes are formatted as an object that contains the match
+		 * `content`, the matching `index`, and the parsed `shortcode` object.
+		 */
 		next: function( tag, text, index ) {
 			var re = wp.shortcode.regexp( tag ),
 				match, result;
 			re.lastIndex = index || 0;
 			}
 			return result;
 		},
-		// ### Replace matching shortcodes in a block of text
+		/*
-		//
+		 * ### Replace matching shortcodes in a block of text.
-		// Accepts a shortcode `tag`, content `text` to scan, and a `callback`
+		 *
-		// to process the shortcode matches and return a replacement string.
+		 * Accepts a shortcode `tag`, content `text` to scan, and a `callback`
-		// Returns the `text` with all shortcodes replaced.
+		 * to process the shortcode matches and return a replacement string.
-		//
+		 * Returns the `text` with all shortcodes replaced.
-		// Shortcode matches are objects that contain the shortcode `tag`,
+		 *
-		// a shortcode `attrs` object, the `content` between shortcode tags,
+		 * Shortcode matches are objects that contain the shortcode `tag`,
-		// and a boolean flag to indicate if the match was a `single` tag.
+		 * a shortcode `attrs` object, the `content` between shortcode tags,
+		 * and a boolean flag to indicate if the match was a `single` tag.
+		 */
 		replace: function( tag, text, callback ) {
 			return text.replace( wp.shortcode.regexp( tag ), function( match, left, tag, attrs, slash, content, closing, right ) {
 				// If both extra brackets exist, the shortcode has been
 				// properly escaped.
 				if ( left === '[' && right === ']' ) {
 				// weren't used to escape the shortcode.
 				return result ? left + result + right : match;
 			});
 		},
-		// ### Generate a string from shortcode parameters
+		/*
-		//
+		 * ### Generate a string from shortcode parameters.
-		// Creates a `wp.shortcode` instance and returns a string.
+		 *
-		//
+		 * Creates a `wp.shortcode` instance and returns a string.
-		// Accepts the same `options` as the `wp.shortcode()` constructor,
+		 *
-		// containing a `tag` string, a string or object of `attrs`, a boolean
+		 * Accepts the same `options` as the `wp.shortcode()` constructor,
-		// indicating whether to format the shortcode using a `single` tag, and a
+		 * containing a `tag` string, a string or object of `attrs`, a boolean
-		// `content` string.
+		 * indicating whether to format the shortcode using a `single` tag, and a
+		 * `content` string.
+		 */
 		string: function( options ) {
 			return new wp.shortcode( options ).string();
 		},
-		// ### Generate a RegExp to identify a shortcode
+		/*
-		//
+		 * ### Generate a RegExp to identify a shortcode.
-		// The base regex is functionally equivalent to the one found in
+		 *
-		// `get_shortcode_regex()` in `wp-includes/shortcodes.php`.
+		 * The base regex is functionally equivalent to the one found in
-		//
+		 * `get_shortcode_regex()` in `wp-includes/shortcodes.php`.
-		// Capture groups:
+		 *
-		//
+		 * Capture groups:
-		// 1. An extra `[` to allow for escaping shortcodes with double `[[]]`
+		 *
-		// 2. The shortcode name
+		 * 1. An extra `[` to allow for escaping shortcodes with double `[[]]`.
-		// 3. The shortcode argument list
+		 * 2. The shortcode name.
-		// 4. The self closing `/`
+		 * 3. The shortcode argument list.
-		// 5. The content of a shortcode when it wraps some content.
+		 * 4. The self closing `/`.
-		// 6. The closing tag.
+		 * 5. The content of a shortcode when it wraps some content.
-		// 7. An extra `]` to allow for escaping shortcodes with double `[[]]`
+		 * 6. The closing tag.
+		 * 7. An extra `]` to allow for escaping shortcodes with double `[[]]`.
+		 */
 		regexp: _.memoize( function( tag ) {
 			return new RegExp( '\\[(\\[?)(' + tag + ')(?![\\w-])([^\\]\\/]*(?:\\/(?!\\])[^\\]\\/]*)*?)(?:(\\/)\\]|\\](?:([^\\[]*(?:\\[(?!\\/\\2\\])[^\\[]*)*)(\\[\\/\\2\\]))?)(\\]?)', 'g' );
 		}),
-		// ### Parse shortcode attributes
+		/*
-		//
+		 * ### Parse shortcode attributes.
-		// Shortcodes accept many types of attributes. These can chiefly be
+		 *
-		// divided into named and numeric attributes:
+		 * Shortcodes accept many types of attributes. These can chiefly be
-		//
+		 * divided into named and numeric attributes:
-		// Named attributes are assigned on a key/value basis, while numeric
+		 *
-		// attributes are treated as an array.
+		 * Named attributes are assigned on a key/value basis, while numeric
-		//
+		 * attributes are treated as an array.
-		// Named attributes can be formatted as either `name="value"`,
+		 *
-		// `name='value'`, or `name=value`. Numeric attributes can be formatted
+		 * Named attributes can be formatted as either `name="value"`,
-		// as `"value"` or just `value`.
+		 * `name='value'`, or `name=value`. Numeric attributes can be formatted
+		 * as `"value"` or just `value`.
+		 */
 		attrs: _.memoize( function( text ) {
 			var named   = {},
 				numeric = [],
 				pattern, match;
-			// This regular expression is reused from `shortcode_parse_atts()`
+			/*
-			// in `wp-includes/shortcodes.php`.
+			 * This regular expression is reused from `shortcode_parse_atts()`
-			//
+			 * in `wp-includes/shortcodes.php`.
-			// Capture groups:
+			 *
-			//
+			 * Capture groups:
-			// 1. An attribute name, that corresponds to...
+			 *
-			// 2. a value in double quotes.
+			 * 1. An attribute name, that corresponds to...
-			// 3. An attribute name, that corresponds to...
+			 * 2. a value in double quotes.
-			// 4. a value in single quotes.
+			 * 3. An attribute name, that corresponds to...
-			// 5. An attribute name, that corresponds to...
+			 * 4. a value in single quotes.
-			// 6. an unquoted value.
+			 * 5. An attribute name, that corresponds to...
-			// 7. A numeric attribute in double quotes.
+			 * 6. an unquoted value.
-			// 8. A numeric attribute in single quotes.
+			 * 7. A numeric attribute in double quotes.
-			// 9. An unquoted numeric attribute.
+			 * 8. A numeric attribute in single quotes.
+			 * 9. An unquoted numeric attribute.
+			 */
 			pattern = /([\w-]+)\s*=\s*"([^"]*)"(?:\s|$)|([\w-]+)\s*=\s*'([^']*)'(?:\s|$)|([\w-]+)\s*=\s*([^\s'"]+)(?:\s|$)|"([^"]*)"(?:\s|$)|'([^']*)'(?:\s|$)|(\S+)(?:\s|$)/g;
 			// Map zero-width spaces to actual spaces.
 			text = text.replace( /[\u00a0\u200b]/g, ' ' );
 				named:   named,
 				numeric: numeric
 			};
 		}),
-		// ### Generate a Shortcode Object from a RegExp match
+		/*
-		// Accepts a `match` object from calling `regexp.exec()` on a `RegExp`
+		 * ### Generate a Shortcode Object from a RegExp match.
-		// generated by `wp.shortcode.regexp()`. `match` can also be set to the
+		 *
-		// `arguments` from a callback passed to `regexp.replace()`.
+		 * Accepts a `match` object from calling `regexp.exec()` on a `RegExp`
+		 * generated by `wp.shortcode.regexp()`. `match` can also be set
+		 * to the `arguments` from a callback passed to `regexp.replace()`.
+		 */
 		fromMatch: function( match ) {
 			var type;
 			if ( match[4] ) {
 				type = 'self-closing';
 			});
 		}
 	};
-	// Shortcode Objects
+	/*
-	// -----------------
+	 * Shortcode Objects
-	//
+	 * -----------------
-	// Shortcode objects are generated automatically when using the main
+	 *
-	// `wp.shortcode` methods: `next()`, `replace()`, and `string()`.
+	 * Shortcode objects are generated automatically when using the main
-	//
+	 * `wp.shortcode` methods: `next()`, `replace()`, and `string()`.
-	// To access a raw representation of a shortcode, pass an `options` object,
+	 *
-	// containing a `tag` string, a string or object of `attrs`, a string
+	 * To access a raw representation of a shortcode, pass an `options` object,
-	// indicating the `type` of the shortcode ('single', 'self-closing', or
+	 * containing a `tag` string, a string or object of `attrs`, a string
-	// 'closed'), and a `content` string.
+	 * indicating the `type` of the shortcode ('single', 'self-closing',
+	 * or 'closed'), and a `content` string.
+	 */
 	wp.shortcode = _.extend( function( options ) {
 		_.extend( this, _.pick( options || {}, 'tag', 'attrs', 'type', 'content' ) );
 		var attrs = this.attrs;
 		// Parse a string of attributes.
 		if ( _.isString( attrs ) ) {
 			this.attrs = wp.shortcode.attrs( attrs );
 		// Identify a correctly formatted `attrs` object.
-		} else if ( _.isEqual( _.keys( attrs ), [ 'named', 'numeric' ] ) ) {
+		} else if ( _.difference( _.keys( attrs ), [ 'named', 'numeric' ] ).length === 0 ) {
-			this.attrs = attrs;
+			this.attrs = _.defaults( attrs, this.attrs );
 		// Handle a flat object of attributes.
 		} else {
 			_.each( options.attrs, function( value, key ) {
 				this.set( key, value );
 			}, this );
 		}
 	}, wp.shortcode );
 	_.extend( wp.shortcode.prototype, {
-		// ### Get a shortcode attribute
+		/*
-		//
+		 * ### Get a shortcode attribute.
-		// Automatically detects whether `attr` is named or numeric and routes
+		 *
-		// it accordingly.
+		 * Automatically detects whether `attr` is named or numeric and routes
+		 * it accordingly.
+		 */
 		get: function( attr ) {
 			return this.attrs[ _.isNumber( attr ) ? 'numeric' : 'named' ][ attr ];
 		},
-		// ### Set a shortcode attribute
+		/*
-		//
+		 * ### Set a shortcode attribute.
-		// Automatically detects whether `attr` is named or numeric and routes
+		 *
-		// it accordingly.
+		 * Automatically detects whether `attr` is named or numeric and routes
+		 * it accordingly.
+		 */
 		set: function( attr, value ) {
 			this.attrs[ _.isNumber( attr ) ? 'numeric' : 'named' ][ attr ] = value;
 			return this;
 		},
-		// ### Transform the shortcode match into a string
+		// ### Transform the shortcode match into a string.
 		string: function() {
 			var text    = '[' + this.tag;
 			_.each( this.attrs.numeric, function( value ) {
 				if ( /\s/.test( value ) ) {
 			return text + '[/' + this.tag + ']';
 		}
 	});
 }());
-// HTML utility functions
+/*
-// ----------------------
+* HTML utility functions
-//
+* ----------------------
-// Experimental. These functions may change or be removed in the future.
+*
+* Experimental. These functions may change or be removed in the future.
+*/
 (function(){
 	wp.html = _.extend( wp.html || {}, {
-		// ### Parse HTML attributes.
+		/*
-		//
+		 * ### Parse HTML attributes.
-		// Converts `content` to a set of parsed HTML attributes.
+		 *
-		// Utilizes `wp.shortcode.attrs( content )`, which is a valid superset of
+		 * Converts `content` to a set of parsed HTML attributes.
-		// the HTML attribute specification. Reformats the attributes into an
+		 * Utilizes `wp.shortcode.attrs( content )`, which is a valid superset of
-		// object that contains the `attrs` with `key:value` mapping, and a record
+		 * the HTML attribute specification. Reformats the attributes into an
-		// of the attributes that were entered using `empty` attribute syntax (i.e.
+		 * object that contains the `attrs` with `key:value` mapping, and a record
-		// with no value).
+		 * of the attributes that were entered using `empty` attribute syntax (i.e.
+		 * with no value).
+		 */
 		attrs: function( content ) {
 			var result, attrs;
 			// If `content` ends in a slash, strip it.
 			if ( '/' === content[ content.length - 1 ] ) {

enmi-conf.org