Changeset 31243

Timestamp:

01/19/2015 08:39:10 AM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/shortcodes.php (modified) (3 diffs)

trunk/src/wp-includes/shortcodes.php

@@ -101 +101 @@
  * @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) {
@@ -131 +131 @@
  * @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 ) {
@@ -181 +182 @@
  * @since 2.5.0
  *
- * @uses $shortcode_tags
- *
- * @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.
  * @return string Content with shortcodes filtered out.
  */