X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..refs/tags/wordpress-4.7.1:/wp-includes/shortcodes.php
diff --git a/wp-includes/shortcodes.php b/wp-includes/shortcodes.php
index 55e64a18..32720cd2 100644
--- a/wp-includes/shortcodes.php
+++ b/wp-includes/shortcodes.php
@@ -1,7 +1,7 @@
- * $out = do_shortcode($content);
- *
+ * $out = do_shortcode( $content );
*
- * @link http://codex.wordpress.org/Shortcode_API
+ * @link https://codex.wordpress.org/Shortcode_API
*
* @package WordPress
* @subpackage Shortcodes
@@ -52,51 +50,59 @@ $shortcode_tags = array();
*
* Simplest example of a shortcode tag using the API:
*
- *
- * // [footag foo="bar"]
- * function footag_func($atts) {
- * return "foo = {$atts[foo]}";
- * }
- * add_shortcode('footag', 'footag_func');
- *
+ * // [footag foo="bar"]
+ * function footag_func( $atts ) {
+ * return "foo = {
+ * $atts[foo]
+ * }";
+ * }
+ * add_shortcode( 'footag', 'footag_func' );
*
* Example with nice attribute defaults:
*
- *
- * // [bartag foo="bar"]
- * function bartag_func($atts) {
- * $args = shortcode_atts(array(
- * 'foo' => 'no foo',
- * 'baz' => 'default baz',
- * ), $atts);
+ * // [bartag foo="bar"]
+ * function bartag_func( $atts ) {
+ * $args = shortcode_atts( array(
+ * 'foo' => 'no foo',
+ * 'baz' => 'default baz',
+ * ), $atts );
*
- * return "foo = {$args['foo']}";
- * }
- * add_shortcode('bartag', 'bartag_func');
- *
+ * return "foo = {$args['foo']}";
+ * }
+ * add_shortcode( 'bartag', 'bartag_func' );
*
* Example with enclosed content:
*
- *
- * // [baztag]content[/baztag]
- * function baztag_func($atts, $content='') {
- * return "content = $content";
- * }
- * add_shortcode('baztag', 'baztag_func');
- *
+ * // [baztag]content[/baztag]
+ * function baztag_func( $atts, $content = '' ) {
+ * return "content = $content";
+ * }
+ * add_shortcode( 'baztag', 'baztag_func' );
*
* @since 2.5.0
*
- * @uses $shortcode_tags
+ * @global array $shortcode_tags
*
- * @param string $tag Shortcode tag to be searched in post content.
+ * @param string $tag Shortcode tag to be searched in post content.
* @param callable $func Hook to run when shortcode is found.
*/
function add_shortcode($tag, $func) {
global $shortcode_tags;
- if ( is_callable($func) )
- $shortcode_tags[$tag] = $func;
+ if ( '' == trim( $tag ) ) {
+ $message = __( 'Invalid shortcode name: Empty name given.' );
+ _doing_it_wrong( __FUNCTION__, $message, '4.4.0' );
+ return;
+ }
+
+ if ( 0 !== preg_match( '@[<>&/\[\]\x00-\x20=]@', $tag ) ) {
+ /* translators: 1: shortcode name, 2: space separated list of reserved characters */
+ $message = sprintf( __( 'Invalid shortcode name: %1$s. Do not use spaces or reserved characters: %2$s' ), $tag, '& / < > [ ] =' );
+ _doing_it_wrong( __FUNCTION__, $message, '4.4.0' );
+ return;
+ }
+
+ $shortcode_tags[ $tag ] = $func;
}
/**
@@ -104,9 +110,9 @@ function add_shortcode($tag, $func) {
*
* @since 2.5.0
*
- * @uses $shortcode_tags
+ * @global array $shortcode_tags
*
- * @param string $tag shortcode tag to remove hook for.
+ * @param string $tag Shortcode tag to remove hook for.
*/
function remove_shortcode($tag) {
global $shortcode_tags;
@@ -123,7 +129,7 @@ function remove_shortcode($tag) {
*
* @since 2.5.0
*
- * @uses $shortcode_tags
+ * @global array $shortcode_tags
*/
function remove_all_shortcodes() {
global $shortcode_tags;
@@ -136,9 +142,10 @@ function remove_all_shortcodes() {
*
* @since 3.6.0
*
- * @global array $shortcode_tags
- * @param string $tag
- * @return boolean
+ * @global array $shortcode_tags List of shortcode tags and their callback hooks.
+ *
+ * @param string $tag Shortcode tag to check.
+ * @return bool Whether the given shortcode exists.
*/
function shortcode_exists( $tag ) {
global $shortcode_tags;
@@ -151,8 +158,10 @@ function shortcode_exists( $tag ) {
* @since 3.6.0
*
* @global array $shortcode_tags
- * @param string $tag
- * @return boolean
+ *
+ * @param string $content Content to search for shortcodes.
+ * @param string $tag Shortcode tag to check.
+ * @return bool Whether the passed content contains the given shortcode.
*/
function has_shortcode( $content, $tag ) {
if ( false === strpos( $content, '[' ) ) {
@@ -160,7 +169,7 @@ function has_shortcode( $content, $tag ) {
}
if ( shortcode_exists( $tag ) ) {
- preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
+ preg_match_all( '/' . get_shortcode_regex() . '/', $content, $matches, PREG_SET_ORDER );
if ( empty( $matches ) )
return false;
@@ -184,13 +193,13 @@ function has_shortcode( $content, $tag ) {
*
* @since 2.5.0
*
- * @uses $shortcode_tags
- * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
+ * @global array $shortcode_tags List of shortcode tags and their callback hooks.
*
- * @param string $content Content to search for shortcodes
+ * @param string $content Content to search for shortcodes.
+ * @param bool $ignore_html When true, shortcodes inside HTML elements will be skipped.
* @return string Content with shortcodes filtered out.
*/
-function do_shortcode($content) {
+function do_shortcode( $content, $ignore_html = false ) {
global $shortcode_tags;
if ( false === strpos( $content, '[' ) ) {
@@ -200,8 +209,23 @@ function do_shortcode($content) {
if (empty($shortcode_tags) || !is_array($shortcode_tags))
return $content;
- $pattern = get_shortcode_regex();
- return preg_replace_callback( "/$pattern/s", 'do_shortcode_tag', $content );
+ // Find all registered tag names in $content.
+ preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches );
+ $tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] );
+
+ if ( empty( $tagnames ) ) {
+ return $content;
+ }
+
+ $content = do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames );
+
+ $pattern = get_shortcode_regex( $tagnames );
+ $content = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $content );
+
+ // Always restore square braces so we don't break things like