Changeset 32624

Timestamp:

05/27/2015 07:39:00 PM (9 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to shortcodes.php.

See #32444.

File:

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

trunk/src/wp-includes/shortcodes.php

@@ -82 +82 @@
  * @since 2.5.0
  *
- * @uses $shortcode_tags
- *
- * @param string $tag Shortcode tag to be searched in post content.
+ * @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.
  */
@@ -99 +99 @@
  * @since 2.5.0
  *
- * @uses $shortcode_tags
+ * @global array $shortcode_tags
  *
  * @param string $tag Shortcode tag to remove hook for.
@@ -118 +118 @@
  * @since 2.5.0
  *
- * @uses $shortcode_tags
+ * @global array $shortcode_tags
  */
 function remove_all_shortcodes() {
@@ -218 +218 @@
  * @since 2.5.0
  *
- * @uses $shortcode_tags
+ * @global array $shortcode_tags
  *
  * @return string The shortcode search regular expression
@@ -266 +266 @@
  * @since 2.5.0
  * @access private
- * @uses $shortcode_tags
+ *
+ * @global array $shortcode_tags
  *
  * @param array $m Regular expression match array
- * @return mixed False on failure.
+ * @return string|false False on failure.
  */
 function do_shortcode_tag( $m ) {
@@ -338 +339 @@
  * @since 2.5.0
  *
- * @param array $pairs Entire list of supported attributes and their defaults.
- * @param array $atts User defined attributes in shortcode tag.
+ * @param array  $pairs     Entire list of supported attributes and their defaults.
+ * @param array  $atts      User defined attributes in shortcode tag.
  * @param string $shortcode Optional. The name of the shortcode, provided for context to enable filtering
  * @return array Combined and filtered attribute list.
@@ -360 +361 @@
      * @since 3.6.0
      *
-     * @param array $out The output array of shortcode attributes.
+     * @param array $out   The output array of shortcode attributes.
      * @param array $pairs The supported attributes and their defaults.
-     * @param array $atts The user defined shortcode attributes.
+     * @param array $atts  The user defined shortcode attributes.
      */
     if ( $shortcode )
@@ -375 +376 @@
  * @since 2.5.0
  *
- * @uses $shortcode_tags
+ * @global array $shortcode_tags
  *
  * @param string $content Content to remove shortcode tags.
@@ -395 +396 @@
 }
 
+/**
+ *
+ * @param array $m
+ * @return string|false
+ */
 function strip_shortcode_tag( $m ) {
     // allow [[foo]] syntax for escaping a tag