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.

Built from https://develop.svn.wordpress.org/trunk@31243


git-svn-id: http://core.svn.wordpress.org/trunk@31224 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-01-19 08:40:24 +00:00
parent a8e2ae2117
commit 3a0726d7b8
2 changed files with 8 additions and 7 deletions

View File

@ -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) {

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.2-alpha-31242';
$wp_version = '4.2-alpha-31243';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.