3
* WordPress API for creating bbcode like tags or what WordPress calls
4
* "shortcodes." The tag and attribute parsing or regular expression code is
5
* based on the Textpattern tag parser.
7
* A few examples are below:
10
* [shortcode foo="bar" baz="bing" /]
11
* [shortcode foo="bar"]content[/shortcode]
13
* Shortcode tags support attributes and enclosed content, but does not entirely
14
* support inline shortcodes in other shortcodes. You will have to call the
15
* shortcode parser in your function to account for that.
18
* Please be aware that the above note was made during the beta of WordPress 2.6
19
* and in the future may not be accurate. Please update the note when it is no
22
* To apply shortcode tags to content:
25
* $out = do_shortcode($content);
28
* @link http://codex.wordpress.org/Shortcode_API
31
* @subpackage Shortcodes
36
* Container for storing shortcode tags and their hook to call for the shortcode
40
* @name $shortcode_tags
42
* @global array $shortcode_tags
44
$shortcode_tags = array();
47
* Add hook for shortcode tag.
49
* There can only be one hook for each shortcode. Which means that if another
50
* plugin has a similar shortcode, it will override yours or yours will override
51
* theirs depending on which order the plugins are included and/or ran.
53
* Simplest example of a shortcode tag using the API:
56
* // [footag foo="bar"]
57
* function footag_func($atts) {
58
* return "foo = {$atts[foo]}";
60
* add_shortcode('footag', 'footag_func');
63
* Example with nice attribute defaults:
66
* // [bartag foo="bar"]
67
* function bartag_func($atts) {
68
* $args = shortcode_atts(array(
70
* 'baz' => 'default baz',
73
* return "foo = {$args['foo']}";
75
* add_shortcode('bartag', 'bartag_func');
78
* Example with enclosed content:
81
* // [baztag]content[/baztag]
82
* function baztag_func($atts, $content='') {
83
* return "content = $content";
85
* add_shortcode('baztag', 'baztag_func');
90
* @uses $shortcode_tags
92
* @param string $tag Shortcode tag to be searched in post content.
93
* @param callable $func Hook to run when shortcode is found.
95
function add_shortcode($tag, $func) {
96
global $shortcode_tags;
98
if ( is_callable($func) )
99
$shortcode_tags[$tag] = $func;
103
* Removes hook for shortcode.
107
* @uses $shortcode_tags
109
* @param string $tag shortcode tag to remove hook for.
111
function remove_shortcode($tag) {
112
global $shortcode_tags;
114
unset($shortcode_tags[$tag]);
118
* Clear all shortcodes.
120
* This function is simple, it clears all of the shortcode tags by replacing the
121
* shortcodes global by a empty array. This is actually a very efficient method
122
* for removing all shortcodes.
126
* @uses $shortcode_tags
128
function remove_all_shortcodes() {
129
global $shortcode_tags;
131
$shortcode_tags = array();
135
* Whether a registered shortcode exists named $tag
139
* @global array $shortcode_tags
143
function shortcode_exists( $tag ) {
144
global $shortcode_tags;
145
return array_key_exists( $tag, $shortcode_tags );
149
* Whether the passed content contains the specified shortcode
153
* @global array $shortcode_tags
157
function has_shortcode( $content, $tag ) {
158
if ( false === strpos( $content, '[' ) ) {
162
if ( shortcode_exists( $tag ) ) {
163
preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
164
if ( empty( $matches ) )
167
foreach ( $matches as $shortcode ) {
168
if ( $tag === $shortcode[2] ) {
170
} elseif ( ! empty( $shortcode[5] ) && has_shortcode( $shortcode[5], $tag ) ) {
179
* Search content for shortcodes and filter shortcodes through their hooks.
181
* If there are no shortcode tags defined, then the content will be returned
182
* without any filtering. This might cause issues when plugins are disabled but
183
* the shortcode will still show up in the post or content.
187
* @uses $shortcode_tags
188
* @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
190
* @param string $content Content to search for shortcodes
191
* @return string Content with shortcodes filtered out.
193
function do_shortcode($content) {
194
global $shortcode_tags;
196
if ( false === strpos( $content, '[' ) ) {
200
if (empty($shortcode_tags) || !is_array($shortcode_tags))
203
$pattern = get_shortcode_regex();
204
return preg_replace_callback( "/$pattern/s", 'do_shortcode_tag', $content );
208
* Retrieve the shortcode regular expression for searching.
210
* The regular expression combines the shortcode tags in the regular expression
213
* The regular expression contains 6 different sub matches to help with parsing.
215
* 1 - An extra [ to allow for escaping shortcodes with double [[]]
216
* 2 - The shortcode name
217
* 3 - The shortcode argument list
218
* 4 - The self closing /
219
* 5 - The content of a shortcode when it wraps some content.
220
* 6 - An extra ] to allow for escaping shortcodes with double [[]]
224
* @uses $shortcode_tags
226
* @return string The shortcode search regular expression
228
function get_shortcode_regex() {
229
global $shortcode_tags;
230
$tagnames = array_keys($shortcode_tags);
231
$tagregexp = join( '|', array_map('preg_quote', $tagnames) );
233
// WARNING! Do not change this regex without changing do_shortcode_tag() and strip_shortcode_tag()
234
// Also, see shortcode_unautop() and shortcode.js.
236
'\\[' // Opening bracket
237
. '(\\[?)' // 1: Optional second opening bracket for escaping shortcodes: [[tag]]
238
. "($tagregexp)" // 2: Shortcode name
239
. '(?![\\w-])' // Not followed by word character or hyphen
240
. '(' // 3: Unroll the loop: Inside the opening shortcode tag
241
. '[^\\]\\/]*' // Not a closing bracket or forward slash
243
. '\\/(?!\\])' // A forward slash not followed by a closing bracket
244
. '[^\\]\\/]*' // Not a closing bracket or forward slash
248
. '(\\/)' // 4: Self closing tag ...
249
. '\\]' // ... and closing bracket
251
. '\\]' // Closing bracket
253
. '(' // 5: Unroll the loop: Optionally, anything between the opening and closing shortcode tags
254
. '[^\\[]*+' // Not an opening bracket
256
. '\\[(?!\\/\\2\\])' // An opening bracket not followed by the closing shortcode tag
257
. '[^\\[]*+' // Not an opening bracket
260
. '\\[\\/\\2\\]' // Closing shortcode tag
263
. '(\\]?)'; // 6: Optional second closing brocket for escaping shortcodes: [[tag]]
267
* Regular Expression callable for do_shortcode() for calling shortcode hook.
268
* @see get_shortcode_regex for details of the match array contents.
272
* @uses $shortcode_tags
274
* @param array $m Regular expression match array
275
* @return mixed False on failure.
277
function do_shortcode_tag( $m ) {
278
global $shortcode_tags;
280
// allow [[foo]] syntax for escaping a tag
281
if ( $m[1] == '[' && $m[6] == ']' ) {
282
return substr($m[0], 1, -1);
286
$attr = shortcode_parse_atts( $m[3] );
288
if ( isset( $m[5] ) ) {
289
// enclosing tag - extra parameter
290
return $m[1] . call_user_func( $shortcode_tags[$tag], $attr, $m[5], $tag ) . $m[6];
293
return $m[1] . call_user_func( $shortcode_tags[$tag], $attr, null, $tag ) . $m[6];
298
* Retrieve all attributes from the shortcodes tag.
300
* The attributes list has the attribute name as the key and the value of the
301
* attribute as the value in the key/value pair. This allows for easier
302
* retrieval of the attributes, since all attributes have to be known.
306
* @param string $text
307
* @return array List of attributes and their value.
309
function shortcode_parse_atts($text) {
311
$pattern = '/(\w+)\s*=\s*"([^"]*)"(?:\s|$)|(\w+)\s*=\s*\'([^\']*)\'(?:\s|$)|(\w+)\s*=\s*([^\s\'"]+)(?:\s|$)|"([^"]*)"(?:\s|$)|(\S+)(?:\s|$)/';
312
$text = preg_replace("/[\x{00a0}\x{200b}]+/u", " ", $text);
313
if ( preg_match_all($pattern, $text, $match, PREG_SET_ORDER) ) {
314
foreach ($match as $m) {
316
$atts[strtolower($m[1])] = stripcslashes($m[2]);
317
elseif (!empty($m[3]))
318
$atts[strtolower($m[3])] = stripcslashes($m[4]);
319
elseif (!empty($m[5]))
320
$atts[strtolower($m[5])] = stripcslashes($m[6]);
321
elseif (isset($m[7]) and strlen($m[7]))
322
$atts[] = stripcslashes($m[7]);
323
elseif (isset($m[8]))
324
$atts[] = stripcslashes($m[8]);
327
$atts = ltrim($text);
333
* Combine user attributes with known attributes and fill in defaults when needed.
335
* The pairs should be considered to be all of the attributes which are
336
* supported by the caller and given as a list. The returned attributes will
337
* only contain the attributes in the $pairs list.
339
* If the $atts list has unsupported attributes, then they will be ignored and
340
* removed from the final returned list.
344
* @param array $pairs Entire list of supported attributes and their defaults.
345
* @param array $atts User defined attributes in shortcode tag.
346
* @param string $shortcode Optional. The name of the shortcode, provided for context to enable filtering
347
* @return array Combined and filtered attribute list.
349
function shortcode_atts( $pairs, $atts, $shortcode = '' ) {
350
$atts = (array)$atts;
352
foreach($pairs as $name => $default) {
353
if ( array_key_exists($name, $atts) )
354
$out[$name] = $atts[$name];
356
$out[$name] = $default;
359
* Filter a shortcode's default attributes.
361
* If the third parameter of the shortcode_atts() function is present then this filter is available.
362
* The third parameter, $shortcode, is the name of the shortcode.
366
* @param array $out The output array of shortcode attributes.
367
* @param array $pairs The supported attributes and their defaults.
368
* @param array $atts The user defined shortcode attributes.
371
$out = apply_filters( "shortcode_atts_{$shortcode}", $out, $pairs, $atts );
377
* Remove all shortcode tags from the given content.
381
* @uses $shortcode_tags
383
* @param string $content Content to remove shortcode tags.
384
* @return string Content without shortcode tags.
386
function strip_shortcodes( $content ) {
387
global $shortcode_tags;
389
if ( false === strpos( $content, '[' ) ) {
393
if (empty($shortcode_tags) || !is_array($shortcode_tags))
396
$pattern = get_shortcode_regex();
398
return preg_replace_callback( "/$pattern/s", 'strip_shortcode_tag', $content );
401
function strip_shortcode_tag( $m ) {
402
// allow [[foo]] syntax for escaping a tag
403
if ( $m[1] == '[' && $m[6] == ']' ) {
404
return substr($m[0], 1, -1);
407
return $m[1] . $m[6];
410
add_filter('the_content', 'do_shortcode', 11); // AFTER wpautop()
added
removed
wp-includes/shortcodes.php
