WordPress 3.9
[autoinstalls/wordpress.git] / wp-includes / shortcodes.php
1 <?php
2 /**
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.
6  *
7  * A few examples are below:
8  *
9  * [shortcode /]
10  * [shortcode foo="bar" baz="bing" /]
11  * [shortcode foo="bar"]content[/shortcode]
12  *
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.
16  *
17  * {@internal
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
20  * longer the case.}}
21  *
22  * To apply shortcode tags to content:
23  *
24  * <code>
25  * $out = do_shortcode($content);
26  * </code>
27  *
28  * @link http://codex.wordpress.org/Shortcode_API
29  *
30  * @package WordPress
31  * @subpackage Shortcodes
32  * @since 2.5.0
33  */
34
35 /**
36  * Container for storing shortcode tags and their hook to call for the shortcode
37  *
38  * @since 2.5.0
39  *
40  * @name $shortcode_tags
41  * @var array
42  * @global array $shortcode_tags
43  */
44 $shortcode_tags = array();
45
46 /**
47  * Add hook for shortcode tag.
48  *
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.
52  *
53  * Simplest example of a shortcode tag using the API:
54  *
55  * <code>
56  * // [footag foo="bar"]
57  * function footag_func($atts) {
58  *      return "foo = {$atts[foo]}";
59  * }
60  * add_shortcode('footag', 'footag_func');
61  * </code>
62  *
63  * Example with nice attribute defaults:
64  *
65  * <code>
66  * // [bartag foo="bar"]
67  * function bartag_func($atts) {
68  *      extract(shortcode_atts(array(
69  *              'foo' => 'no foo',
70  *              'baz' => 'default baz',
71  *      ), $atts));
72  *
73  *      return "foo = {$foo}";
74  * }
75  * add_shortcode('bartag', 'bartag_func');
76  * </code>
77  *
78  * Example with enclosed content:
79  *
80  * <code>
81  * // [baztag]content[/baztag]
82  * function baztag_func($atts, $content='') {
83  *      return "content = $content";
84  * }
85  * add_shortcode('baztag', 'baztag_func');
86  * </code>
87  *
88  * @since 2.5.0
89  *
90  * @uses $shortcode_tags
91  *
92  * @param string $tag Shortcode tag to be searched in post content.
93  * @param callable $func Hook to run when shortcode is found.
94  */
95 function add_shortcode($tag, $func) {
96         global $shortcode_tags;
97
98         if ( is_callable($func) )
99                 $shortcode_tags[$tag] = $func;
100 }
101
102 /**
103  * Removes hook for shortcode.
104  *
105  * @since 2.5.0
106  *
107  * @uses $shortcode_tags
108  *
109  * @param string $tag shortcode tag to remove hook for.
110  */
111 function remove_shortcode($tag) {
112         global $shortcode_tags;
113
114         unset($shortcode_tags[$tag]);
115 }
116
117 /**
118  * Clear all shortcodes.
119  *
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.
123  *
124  * @since 2.5.0
125  *
126  * @uses $shortcode_tags
127  */
128 function remove_all_shortcodes() {
129         global $shortcode_tags;
130
131         $shortcode_tags = array();
132 }
133
134 /**
135  * Whether a registered shortcode exists named $tag
136  *
137  * @since 3.6.0
138  *
139  * @global array $shortcode_tags
140  * @param string $tag
141  * @return boolean
142  */
143 function shortcode_exists( $tag ) {
144         global $shortcode_tags;
145         return array_key_exists( $tag, $shortcode_tags );
146 }
147
148 /**
149  * Whether the passed content contains the specified shortcode
150  *
151  * @since 3.6.0
152  *
153  * @global array $shortcode_tags
154  * @param string $tag
155  * @return boolean
156  */
157 function has_shortcode( $content, $tag ) {
158         if ( false === strpos( $content, '[' ) ) {
159                 return false;
160         }
161
162         if ( shortcode_exists( $tag ) ) {
163                 preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
164                 if ( empty( $matches ) )
165                         return false;
166
167                 foreach ( $matches as $shortcode ) {
168                         if ( $tag === $shortcode[2] )
169                                 return true;
170                 }
171         }
172         return false;
173 }
174
175 /**
176  * Search content for shortcodes and filter shortcodes through their hooks.
177  *
178  * If there are no shortcode tags defined, then the content will be returned
179  * without any filtering. This might cause issues when plugins are disabled but
180  * the shortcode will still show up in the post or content.
181  *
182  * @since 2.5.0
183  *
184  * @uses $shortcode_tags
185  * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
186  *
187  * @param string $content Content to search for shortcodes
188  * @return string Content with shortcodes filtered out.
189  */
190 function do_shortcode($content) {
191         global $shortcode_tags;
192
193         if ( false === strpos( $content, '[' ) ) {
194                 return $content;
195         }
196
197         if (empty($shortcode_tags) || !is_array($shortcode_tags))
198                 return $content;
199
200         $pattern = get_shortcode_regex();
201         return preg_replace_callback( "/$pattern/s", 'do_shortcode_tag', $content );
202 }
203
204 /**
205  * Retrieve the shortcode regular expression for searching.
206  *
207  * The regular expression combines the shortcode tags in the regular expression
208  * in a regex class.
209  *
210  * The regular expression contains 6 different sub matches to help with parsing.
211  *
212  * 1 - An extra [ to allow for escaping shortcodes with double [[]]
213  * 2 - The shortcode name
214  * 3 - The shortcode argument list
215  * 4 - The self closing /
216  * 5 - The content of a shortcode when it wraps some content.
217  * 6 - An extra ] to allow for escaping shortcodes with double [[]]
218  *
219  * @since 2.5.0
220  *
221  * @uses $shortcode_tags
222  *
223  * @return string The shortcode search regular expression
224  */
225 function get_shortcode_regex() {
226         global $shortcode_tags;
227         $tagnames = array_keys($shortcode_tags);
228         $tagregexp = join( '|', array_map('preg_quote', $tagnames) );
229
230         // WARNING! Do not change this regex without changing do_shortcode_tag() and strip_shortcode_tag()
231         // Also, see shortcode_unautop() and shortcode.js.
232         return
233                   '\\['                              // Opening bracket
234                 . '(\\[?)'                           // 1: Optional second opening bracket for escaping shortcodes: [[tag]]
235                 . "($tagregexp)"                     // 2: Shortcode name
236                 . '(?![\\w-])'                       // Not followed by word character or hyphen
237                 . '('                                // 3: Unroll the loop: Inside the opening shortcode tag
238                 .     '[^\\]\\/]*'                   // Not a closing bracket or forward slash
239                 .     '(?:'
240                 .         '\\/(?!\\])'               // A forward slash not followed by a closing bracket
241                 .         '[^\\]\\/]*'               // Not a closing bracket or forward slash
242                 .     ')*?'
243                 . ')'
244                 . '(?:'
245                 .     '(\\/)'                        // 4: Self closing tag ...
246                 .     '\\]'                          // ... and closing bracket
247                 . '|'
248                 .     '\\]'                          // Closing bracket
249                 .     '(?:'
250                 .         '('                        // 5: Unroll the loop: Optionally, anything between the opening and closing shortcode tags
251                 .             '[^\\[]*+'             // Not an opening bracket
252                 .             '(?:'
253                 .                 '\\[(?!\\/\\2\\])' // An opening bracket not followed by the closing shortcode tag
254                 .                 '[^\\[]*+'         // Not an opening bracket
255                 .             ')*+'
256                 .         ')'
257                 .         '\\[\\/\\2\\]'             // Closing shortcode tag
258                 .     ')?'
259                 . ')'
260                 . '(\\]?)';                          // 6: Optional second closing brocket for escaping shortcodes: [[tag]]
261 }
262
263 /**
264  * Regular Expression callable for do_shortcode() for calling shortcode hook.
265  * @see get_shortcode_regex for details of the match array contents.
266  *
267  * @since 2.5.0
268  * @access private
269  * @uses $shortcode_tags
270  *
271  * @param array $m Regular expression match array
272  * @return mixed False on failure.
273  */
274 function do_shortcode_tag( $m ) {
275         global $shortcode_tags;
276
277         // allow [[foo]] syntax for escaping a tag
278         if ( $m[1] == '[' && $m[6] == ']' ) {
279                 return substr($m[0], 1, -1);
280         }
281
282         $tag = $m[2];
283         $attr = shortcode_parse_atts( $m[3] );
284
285         if ( isset( $m[5] ) ) {
286                 // enclosing tag - extra parameter
287                 return $m[1] . call_user_func( $shortcode_tags[$tag], $attr, $m[5], $tag ) . $m[6];
288         } else {
289                 // self-closing tag
290                 return $m[1] . call_user_func( $shortcode_tags[$tag], $attr, null,  $tag ) . $m[6];
291         }
292 }
293
294 /**
295  * Retrieve all attributes from the shortcodes tag.
296  *
297  * The attributes list has the attribute name as the key and the value of the
298  * attribute as the value in the key/value pair. This allows for easier
299  * retrieval of the attributes, since all attributes have to be known.
300  *
301  * @since 2.5.0
302  *
303  * @param string $text
304  * @return array List of attributes and their value.
305  */
306 function shortcode_parse_atts($text) {
307         $atts = array();
308         $pattern = '/(\w+)\s*=\s*"([^"]*)"(?:\s|$)|(\w+)\s*=\s*\'([^\']*)\'(?:\s|$)|(\w+)\s*=\s*([^\s\'"]+)(?:\s|$)|"([^"]*)"(?:\s|$)|(\S+)(?:\s|$)/';
309         $text = preg_replace("/[\x{00a0}\x{200b}]+/u", " ", $text);
310         if ( preg_match_all($pattern, $text, $match, PREG_SET_ORDER) ) {
311                 foreach ($match as $m) {
312                         if (!empty($m[1]))
313                                 $atts[strtolower($m[1])] = stripcslashes($m[2]);
314                         elseif (!empty($m[3]))
315                                 $atts[strtolower($m[3])] = stripcslashes($m[4]);
316                         elseif (!empty($m[5]))
317                                 $atts[strtolower($m[5])] = stripcslashes($m[6]);
318                         elseif (isset($m[7]) and strlen($m[7]))
319                                 $atts[] = stripcslashes($m[7]);
320                         elseif (isset($m[8]))
321                                 $atts[] = stripcslashes($m[8]);
322                 }
323         } else {
324                 $atts = ltrim($text);
325         }
326         return $atts;
327 }
328
329 /**
330  * Combine user attributes with known attributes and fill in defaults when needed.
331  *
332  * The pairs should be considered to be all of the attributes which are
333  * supported by the caller and given as a list. The returned attributes will
334  * only contain the attributes in the $pairs list.
335  *
336  * If the $atts list has unsupported attributes, then they will be ignored and
337  * removed from the final returned list.
338  *
339  * @since 2.5.0
340  *
341  * @param array $pairs Entire list of supported attributes and their defaults.
342  * @param array $atts User defined attributes in shortcode tag.
343  * @param string $shortcode Optional. The name of the shortcode, provided for context to enable filtering
344  * @return array Combined and filtered attribute list.
345  */
346 function shortcode_atts( $pairs, $atts, $shortcode = '' ) {
347         $atts = (array)$atts;
348         $out = array();
349         foreach($pairs as $name => $default) {
350                 if ( array_key_exists($name, $atts) )
351                         $out[$name] = $atts[$name];
352                 else
353                         $out[$name] = $default;
354         }
355         /**
356          * Filter a shortcode's default attributes.
357          *
358          * If the third parameter of the shortcode_atts() function is present then this filter is available.
359          * The third parameter, $shortcode, is the name of the shortcode.
360          *
361          * @since 3.6.0
362          *
363          * @param array $out The output array of shortcode attributes.
364          * @param array $pairs The supported attributes and their defaults.
365          * @param array $atts The user defined shortcode attributes.
366          */
367         if ( $shortcode )
368                 $out = apply_filters( "shortcode_atts_{$shortcode}", $out, $pairs, $atts );
369
370         return $out;
371 }
372
373 /**
374  * Remove all shortcode tags from the given content.
375  *
376  * @since 2.5.0
377  *
378  * @uses $shortcode_tags
379  *
380  * @param string $content Content to remove shortcode tags.
381  * @return string Content without shortcode tags.
382  */
383 function strip_shortcodes( $content ) {
384         global $shortcode_tags;
385
386         if ( false === strpos( $content, '[' ) ) {
387                 return $content;
388         }
389
390         if (empty($shortcode_tags) || !is_array($shortcode_tags))
391                 return $content;
392
393         $pattern = get_shortcode_regex();
394
395         return preg_replace_callback( "/$pattern/s", 'strip_shortcode_tag', $content );
396 }
397
398 function strip_shortcode_tag( $m ) {
399         // allow [[foo]] syntax for escaping a tag
400         if ( $m[1] == '[' && $m[6] == ']' ) {
401                 return substr($m[0], 1, -1);
402         }
403
404         return $m[1] . $m[6];
405 }
406
407 add_filter('the_content', 'do_shortcode', 11); // AFTER wpautop()