Changeset 45895

Timestamp:

08/26/2019 04:59:53 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Reference WP_Term_Query::__construct() in wp_list_categories() DocBlock for additional accepted arguments.

Clarify that wp_dropdown_categories() always returns a string, regardless of the echo parameter.

See #47896, #47110.

File:

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

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

@@ -289 +289 @@
  * @since 4.6.0 Introduced the `required` argument.
  *
- * @param string|array $args {
+ * @param array|string $args {
  *     Optional. Array or string of arguments to generate a categories drop-down element. See WP_Term_Query::__construct()
  *     for information on additional accepted arguments.
@@ -322 +322 @@
  *                                           Default false.
  * }
- * @return string HTML content only if 'echo' argument is 0.
+ * @return string HTML dropdown list of categories.
  */
 function wp_dropdown_categories( $args = '' ) {
@@ -447 +447 @@
         $output .= "</select>\n";
     }
+
     /**
      * Filters the taxonomy drop-down output.
@@ -460 +461 @@
         echo $output;
     }
+
     return $output;
 }
@@ -467 +469 @@
  *
  * @since 2.1.0
- * @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments. The `current_category` argument was modified to
- *              optionally accept an array of values.
- *
- * @param string|array $args {
- *     Array of optional arguments. See get_categories(), get_terms(), and WP_Tax_Query::construct()
- *     for full lists of arguments that can be passed in `$args`.
+ * @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments.
+ * @since 4.4.0 The `current_category` argument was modified to optionally accept an array of values.
+ *
+ * @param array|string $args {
+ *     Array of optional arguments. See get_categories(), get_terms(), and WP_Term_Query::__construct()
+ *     for information on additional accepted arguments.
  *
  *     @type int|array    $current_category      ID of category, or array of IDs of categories, that should get the
@@ -504 +506 @@
  *                                               Default 1.
  * }
- * @return false|string HTML content only if 'echo' argument is 0.
+ * @return false|string HTML list of categories only if 'echo' argument is 0.
  */
 function wp_list_categories( $args = '' ) {