From 73780fdd3205004b9c2868ab4a4f9ac8e53fc27b Mon Sep 17 00:00:00 2001 From: "Drew Jaynes (DrewAPicture)" Date: Mon, 19 Jan 2015 08:39:10 +0000 Subject: [PATCH] Add more complete documentation for parameters, globals, and return values to the DocBlocks for `remove_shortcode()`, `shortcode_exists()`, and `do_shortcode()`. Props SergeyBiryukov. Fixes #31048. git-svn-id: https://develop.svn.wordpress.org/trunk@31243 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/shortcodes.php | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/wp-includes/shortcodes.php b/src/wp-includes/shortcodes.php index 181aea048b..ecefbe06ae 100644 --- a/src/wp-includes/shortcodes.php +++ b/src/wp-includes/shortcodes.php @@ -100,7 +100,7 @@ function add_shortcode($tag, $func) { * * @uses $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; @@ -130,9 +130,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; @@ -180,9 +181,9 @@ function has_shortcode( $content, $tag ) { * * @since 2.5.0 * - * @uses $shortcode_tags + * @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. * @return string Content with shortcodes filtered out. */ function do_shortcode($content) {