Changeset 47930

Timestamp:

06/09/2020 11:12:57 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document that get_tags() returns a WP_Error object if any of the specified taxonomies do not exist.

Props coffee2code.
Fixes #50344.

Location:

trunk/src/wp-includes

Files:

• category.php (modified) (2 diffs)
• taxonomy.php (modified) (1 diff)

trunk/src/wp-includes/category.php

@@ -281 +281 @@
  *
  * @since 2.3.0
- * @see get_terms() For list of arguments to pass.
- *
- * @param string|array $args Tag arguments to use when retrieving tags.
- * @return WP_Term[]|int $tags Array of 'post_tag' term objects, or a count thereof.
+ *
+ * @param string|array $args {
+ *     Optional. Arguments to retrieve tags. See get_terms() for additional options.
+ *
+ *     @type string $taxonomy Taxonomy to retrieve terms for. Default 'post_tag'.
+ * }
+ * @return WP_Term[]|int|WP_Error $tags Array of 'post_tag' term objects, a count thereof,
+ *                                      or WP_Error if any of the taxonomies do not exist.
  */
 function get_tags( $args = '' ) {
@@ -293 +297 @@
 
     if ( empty( $tags ) ) {
-        $return = array();
-        return $return;
-    }
-
-    /**
-     * Filters the array of term objects returned for the 'post_tag' taxonomy.
-     *
-     * @since 2.3.0
-     *
-     * @param WP_Term[]|int $tags Array of 'post_tag' term objects, or a count thereof.
-     * @param array         $args An array of arguments. @see get_terms()
-     */
-    $tags = apply_filters( 'get_tags', $tags, $args );
+        $tags = array();
+    } else {
+        /**
+         * Filters the array of term objects returned for the 'post_tag' taxonomy.
+         *
+         * @since 2.3.0
+         *
+         * @param WP_Term[]|int|WP_Error $tags Array of 'post_tag' term objects, a count thereof,
+         *                                     or WP_Error if any of the taxonomies do not exist.
+         * @param array                  $args An array of arguments. @see get_terms()
+         */
+        $tags = apply_filters( 'get_tags', $tags, $args );
+    }
 
     return $tags;

trunk/src/wp-includes/taxonomy.php

@@ -1134 +1134 @@
  * @param array|string $args       Optional. Array or string of arguments. See WP_Term_Query::__construct()
  *                                 for information on accepted arguments. Default empty.
- * @param array|string $deprecated Argument array, when using the legacy function parameter format. If present, this
- *                                 parameter will be interpreted as `$args`, and the first function parameter will
- *                                 be parsed as a taxonomy or array of taxonomies.
- * @return WP_Term[]|int|WP_Error List of WP_Term instances and their children. Will return WP_Error, if any of taxonomies
- *                                do not exist.
+ * @param array|string $deprecated Argument array, when using the legacy function parameter format. If present,
+ *                                 this parameter will be interpreted as `$args`, and the first function parameter
+ *                                 will be parsed as a taxonomy or array of taxonomies.
+ * @return WP_Term[]|int|WP_Error Array of WP_Term instances, a count thereof,
+ *                                or WP_Error if any of the taxonomies do not exist.
  */
 function get_terms( $args = array(), $deprecated = '' ) {