X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/8f374b7233bc2815ccc387e448d208c5434eb961..dc1231b7312fbdca99e9e887cc2bb35a28f85cdc:/wp-includes/shortcodes.php diff --git a/wp-includes/shortcodes.php b/wp-includes/shortcodes.php index 1b860d27..86976a21 100644 --- a/wp-includes/shortcodes.php +++ b/wp-includes/shortcodes.php @@ -21,21 +21,20 @@ * * To apply shortcode tags to content: * - * - * $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 - * @since 2.5 + * @since 2.5.0 */ /** * Container for storing shortcode tags and their hook to call for the shortcode * - * @since 2.5 + * @since 2.5.0 + * * @name $shortcode_tags * @var array * @global array $shortcode_tags @@ -51,59 +50,55 @@ $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) { - * extract(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 = {$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 * - * @since 2.5 - * @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; + $shortcode_tags[ $tag ] = $func; } /** * Removes hook for shortcode. * - * @since 2.5 - * @uses $shortcode_tags + * @since 2.5.0 * - * @param string $tag shortcode tag to remove hook for. + * @global array $shortcode_tags + * + * @param string $tag Shortcode tag to remove hook for. */ function remove_shortcode($tag) { global $shortcode_tags; @@ -118,8 +113,9 @@ function remove_shortcode($tag) { * shortcodes global by a empty array. This is actually a very efficient method * for removing all shortcodes. * - * @since 2.5 - * @uses $shortcode_tags + * @since 2.5.0 + * + * @global array $shortcode_tags */ function remove_all_shortcodes() { global $shortcode_tags; @@ -127,6 +123,53 @@ function remove_all_shortcodes() { $shortcode_tags = array(); } +/** + * Whether a registered shortcode exists named $tag + * + * @since 3.6.0 + * + * @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; + return array_key_exists( $tag, $shortcode_tags ); +} + +/** + * Whether the passed content contains the specified shortcode + * + * @since 3.6.0 + * + * @global array $shortcode_tags + * + * @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, '[' ) ) { + return false; + } + + if ( shortcode_exists( $tag ) ) { + preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER ); + if ( empty( $matches ) ) + return false; + + foreach ( $matches as $shortcode ) { + if ( $tag === $shortcode[2] ) { + return true; + } elseif ( ! empty( $shortcode[5] ) && has_shortcode( $shortcode[5], $tag ) ) { + return true; + } + } + } + return false; +} + /** * Search content for shortcodes and filter shortcodes through their hooks. * @@ -134,21 +177,42 @@ function remove_all_shortcodes() { * without any filtering. This might cause issues when plugins are disabled but * the shortcode will still show up in the post or content. * - * @since 2.5 - * @uses $shortcode_tags - * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes. + * @since 2.5.0 * - * @param string $content Content to search for shortcodes + * @global array $shortcode_tags List of shortcode tags and their callback hooks. + * + * @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, '[' ) ) { + return $content; + } + if (empty($shortcode_tags) || !is_array($shortcode_tags)) return $content; + $tagnames = array_keys($shortcode_tags); + $tagregexp = join( '|', array_map('preg_quote', $tagnames) ); + $pattern = "/\\[($tagregexp)/s"; + + if ( 1 !== preg_match( $pattern, $content ) ) { + // Avoids parsing HTML when there are no shortcodes or embeds anyway. + return $content; + } + + $content = do_shortcodes_in_html_tags( $content, $ignore_html ); + $pattern = get_shortcode_regex(); - return preg_replace_callback( "/$pattern/s", 'do_shortcode_tag', $content ); + $content = preg_replace_callback( "/$pattern/s", 'do_shortcode_tag', $content ); + + // Always restore square braces so we don't break things like