X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..refs/tags/wordpress-4.7.1:/wp-includes/shortcodes.php diff --git a/wp-includes/shortcodes.php b/wp-includes/shortcodes.php index 907f7ff3..32720cd2 100644 --- a/wp-includes/shortcodes.php +++ b/wp-includes/shortcodes.php @@ -1,107 +1,513 @@ 'no foo', + * 'baz' => 'default baz', + * ), $atts ); + * + * 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' ); + * + * @since 2.5.0 + * + * @global array $shortcode_tags + * + * @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; -An API for creating shortcode tags that support attributes and enclosed content, such as: + if ( '' == trim( $tag ) ) { + $message = __( 'Invalid shortcode name: Empty name given.' ); + _doing_it_wrong( __FUNCTION__, $message, '4.4.0' ); + return; + } -[shortcode /] -[shortcode foo="bar" baz="bing" /] -[shortcode foo="bar"]content[/shortcode] + 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; + } -tag and attrbute parsing regexp code based on the Textpattern tag parser. + $shortcode_tags[ $tag ] = $func; +} -To apply shortcode tags to content: +/** + * Removes hook for shortcode. + * + * @since 2.5.0 + * + * @global array $shortcode_tags + * + * @param string $tag Shortcode tag to remove hook for. + */ +function remove_shortcode($tag) { + global $shortcode_tags; -$out = do_shortcode($content); + unset($shortcode_tags[$tag]); +} -Simplest example of a shortcode tag using the API: +/** + * Clear all shortcodes. + * + * This function is simple, it clears all of the shortcode tags by replacing the + * shortcodes global by a empty array. This is actually a very efficient method + * for removing all shortcodes. + * + * @since 2.5.0 + * + * @global array $shortcode_tags + */ +function remove_all_shortcodes() { + global $shortcode_tags; -// [footag foo="bar"] -function footag_func($atts) { - return "foo = {$atts[foo]}"; + $shortcode_tags = array(); } -add_shortcode('footag', 'footag_func'); -Example with nice attribute defaults: +/** + * 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 ); +} -// [bartag foo="bar"] -function bartag_func($atts) { - extract(shortcode_atts(array( - 'foo' => 'no foo', - 'baz' => 'default baz', - ), $atts)); +/** + * 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; + } - return "foo = {$foo}"; + if ( shortcode_exists( $tag ) ) { + preg_match_all( '/' . get_shortcode_regex() . '/', $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; } -add_shortcode('bartag', 'bartag_func'); -Example with enclosed content: +/** + * Search content for shortcodes and filter shortcodes through their hooks. + * + * If there are no shortcode tags defined, then the content will be returned + * 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.0 + * + * @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, $ignore_html = false ) { + global $shortcode_tags; -// [baztag]content[/baztag] -function baztag_func($atts, $content='') { - return "content = $content"; -} -add_shortcode('baztag', 'baztag_func'); + if ( false === strpos( $content, '[' ) ) { + return $content; + } + + if (empty($shortcode_tags) || !is_array($shortcode_tags)) + return $content; -*/ + // Find all registered tag names in $content. + preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches ); + $tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] ); -$shortcode_tags = array(); + if ( empty( $tagnames ) ) { + return $content; + } -function add_shortcode($tag, $func) { - global $shortcode_tags; + $content = do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames ); - if ( is_callable($func) ) - $shortcode_tags[$tag] = $func; -} + $pattern = get_shortcode_regex( $tagnames ); + $content = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $content ); -function remove_shortcode($tag) { - global $shortcode_tags; + // Always restore square braces so we don't break things like