Changeset 49693 for trunk/src/wp-includes/category-template.php

Timestamp:

11/24/2020 09:25:46 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Upgrade more parameters in docblocks to used typed array notation.

See #51800, #41756

File:

• trunk/src/wp-includes/category-template.php (modified) (5 diffs)

trunk/src/wp-includes/category-template.php

@@ -697 +697 @@
  *     @type bool   $echo      Whether or not to echo the return value. Default true.
  * }
- * @return void|string|array Void if 'echo' argument is true, or on failure. Otherwise, tag cloud
- *                           as a string or an array, depending on 'format' argument.
+ * @return void|string|string[] Void if 'echo' argument is true, or on failure. Otherwise, tag cloud
+ *                              as a string or an array, depending on 'format' argument.
  */
 function wp_tag_cloud( $args = '' ) {
@@ -758 +758 @@
      * @since 2.3.0
      *
-     * @param string|array $return Tag cloud as a string or an array, depending on 'format' argument.
-     * @param array        $args   An array of tag cloud arguments.
+     * @param string|string[] $return Tag cloud as a string or an array, depending on 'format' argument.
+     * @param array           $args   An array of tag cloud arguments.
      */
     $return = apply_filters( 'wp_tag_cloud', $return, $args );
@@ -826 +826 @@
  *                                                0, 1, or their bool equivalents.
  * }
- * @return string|array Tag cloud as a string or an array, depending on 'format' argument.
+ * @return string|string[] Tag cloud as a string or an array, depending on 'format' argument.
  */
 function wp_generate_tag_cloud( $tags, $args = '' ) {
@@ -980 +980 @@
      * @since 4.3.0
      *
-     * @param array $tags_data An array of term data for term used to generate the tag cloud.
+     * @param array[] $tags_data An array of term data arrays for terms used to generate the tag cloud.
      */
     $tags_data = apply_filters( 'wp_generate_tag_cloud_data', $tags_data );
@@ -1031 +1031 @@
          * @see wp_generate_tag_cloud()
          *
-         * @param array|string $return String containing the generated HTML tag cloud output
-         *                             or an array of tag links if the 'format' argument
-         *                             equals 'array'.
-         * @param WP_Term[]    $tags   An array of terms used in the tag cloud.
-         * @param array        $args   An array of wp_generate_tag_cloud() arguments.
+         * @param string[]|string $return String containing the generated HTML tag cloud output
+         *                                or an array of tag links if the 'format' argument
+         *                                equals 'array'.
+         * @param WP_Term[]       $tags   An array of terms used in the tag cloud.
+         * @param array           $args   An array of wp_generate_tag_cloud() arguments.
          */
         return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );