* Utility functions for parsing and handling shortcodes in JavaScript.
* @output wp-includes/js/shortcode.js
* Ensure the global `wp` object exists.
window.wp = window.wp || {};
* ### 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`.
* 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 ),
re.lastIndex = index || 0;
// If we matched an escaped shortcode, try again.
if ( '[' === match[1] && ']' === match[7] ) {
return wp.shortcode.next( tag, text, re.lastIndex );
shortcode: wp.shortcode.fromMatch( match )
// If we matched a leading `[`, strip it from the match
// and increment the index accordingly.
result.content = result.content.slice( 1 );
// If we matched a trailing `]`, strip it from the match.
result.content = result.content.slice( 0, -1 );
* ### 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.
* 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,
* 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
if ( left === '[' && right === ']' ) {
// Create the match object and pass it through the callback.
var result = callback( wp.shortcode.fromMatch( arguments ) );
// Make sure to return any of the extra brackets if they
// weren't used to escape the shortcode.
return result ? left + result + right : match;
* ### Generate a string from shortcode parameters.
* 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
* indicating whether to format the shortcode using a `single` tag, and a
string: function( options ) {
return new wp.shortcode( options ).string();
* ### 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`.
* 1. An extra `[` to allow for escaping shortcodes with double `[[]]`.
* 3. The shortcode argument list.
* 4. The self closing `/`.
* 5. The content of a shortcode when it wraps some content.
* 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.
* 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 can be formatted as either `name="value"`,
* `name='value'`, or `name=value`. Numeric attributes can be formatted
* as `"value"` or just `value`.
attrs: _.memoize( function( text ) {
* This regular expression is reused from `shortcode_parse_atts()`
* in `wp-includes/shortcodes.php`.
* 1. An attribute name, that corresponds to...
* 2. a value in double quotes.
* 3. An attribute name, that corresponds to...
* 4. a value in single quotes.
* 5. An attribute name, that corresponds to...
* 7. A numeric attribute in double quotes.
* 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, ' ' );
// Match and normalize attributes.
while ( (match = pattern.exec( text )) ) {
named[ match[1].toLowerCase() ] = match[2];
named[ match[3].toLowerCase() ] = match[4];
named[ match[5].toLowerCase() ] = match[6];
numeric.push( match[7] );
numeric.push( match[8] );
numeric.push( match[9] );
* ### Generate a Shortcode Object from a RegExp match.
* 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 ) {
return new wp.shortcode({
* 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
* 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' ) );
// Ensure we have a correctly formatted `attrs` object.
// Parse a string of attributes.
if ( _.isString( attrs ) ) {
this.attrs = wp.shortcode.attrs( attrs );
// Identify a correctly formatted `attrs` object.
} else if ( _.difference( _.keys( attrs ), [ 'named', 'numeric' ] ).length === 0 ) {
this.attrs = _.defaults( attrs, this.attrs );
// Handle a flat object of attributes.
_.each( options.attrs, function( value, key ) {
_.extend( wp.shortcode.prototype, {
* ### Get a shortcode attribute.
* Automatically detects whether `attr` is named or numeric and routes
return this.attrs[ _.isNumber( attr ) ? 'numeric' : 'named' ][ attr ];
* ### Set a shortcode attribute.
* Automatically detects whether `attr` is named or numeric and routes
set: function( attr, value ) {
this.attrs[ _.isNumber( attr ) ? 'numeric' : 'named' ][ attr ] = value;
// ### Transform the shortcode match into a string.
var text = '[' + this.tag;
_.each( this.attrs.numeric, function( value ) {
if ( /\s/.test( value ) ) {
text += ' "' + value + '"';
_.each( this.attrs.named, function( value, name ) {
text += ' ' + name + '="' + value + '"';
// If the tag is marked as `single` or `self-closing`, close the
// tag and ignore any additional content.
if ( 'single' === this.type ) {
} else if ( 'self-closing' === this.type ) {
// Complete the opening tag.
return text + '[/' + this.tag + ']';
* Experimental. These functions may change or be removed in the future.
wp.html = _.extend( wp.html || {}, {
* ### Parse HTML attributes.
* Converts `content` to a set of parsed HTML attributes.
* Utilizes `wp.shortcode.attrs( content )`, which is a valid superset of
* the HTML attribute specification. Reformats the attributes into an
* object that contains the `attrs` with `key:value` mapping, and a record
* of the attributes that were entered using `empty` attribute syntax (i.e.
attrs: function( content ) {
// If `content` ends in a slash, strip it.
if ( '/' === content[ content.length - 1 ] ) {
content = content.slice( 0, -1 );
result = wp.shortcode.attrs( content );
_.each( result.numeric, function( key ) {
if ( /\s/.test( key ) ) {
// ### Convert an HTML-representation of an object to a string.
string: function( options ) {
var text = '<' + options.tag,
content = options.content || '';
_.each( options.attrs, function( value, attr ) {
// Convert boolean values to strings.
if ( _.isBoolean( value ) ) {
value = value ? 'true' : 'false';
text += '="' + value + '"';
// Return the result if it is a self-closing tag.
// Complete the opening tag.
// If `content` is an object, recursively call this function.
text += _.isObject( content ) ? wp.html.string( content ) : content;
return text + '</' + options.tag + '>';
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
