Changeset 49597 for trunk/src/wp-includes/taxonomy.php

Timestamp:

11/14/2020 04:33:52 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #50768

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -2049 +2049 @@
  * @param string|string[] $taxonomies The taxonomy names to retrieve terms from.
  * @param array|string    $args       See WP_Term_Query::__construct() for supported arguments.
- * @return array|WP_Error The requested term data or empty array if no terms found.
- *                        WP_Error if any of the taxonomies don't exist.
+ * @return WP_Term[]|WP_Error Array of terms or empty array if no terms found.
+ *                            WP_Error if any of the taxonomies don't exist.
  */
 function wp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
@@ -2126 +2126 @@
      * @since 4.2.0
      *
-     * @param array    $terms      Array of terms for the given object or objects.
-     * @param int[]    $object_ids Array of object IDs for which terms were retrieved.
-     * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved.
-     * @param array    $args       Array of arguments for retrieving terms for the given
-     *                             object(s). See wp_get_object_terms() for details.
+     * @param WP_Term[] $terms      Array of terms for the given object or objects.
+     * @param int[]     $object_ids Array of object IDs for which terms were retrieved.
+     * @param string[]  $taxonomies Array of taxonomy names from which terms were retrieved.
+     * @param array     $args       Array of arguments for retrieving terms for the given
+     *                              object(s). See wp_get_object_terms() for details.
      */
     $terms = apply_filters( 'get_object_terms', $terms, $object_ids, $taxonomies, $args );
@@ -2145 +2145 @@
      * @since 2.8.0
      *
-     * @param array    $terms      Array of terms for the given object or objects.
-     * @param int[]    $object_ids Array of object IDs for which terms were retrieved.
-     * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved.
-     * @param array    $args       Array of arguments for retrieving terms for the given
-     *                             object(s). See wp_get_object_terms() for details.
+     * @param WP_Term[] $terms      Array of terms for the given object or objects.
+     * @param string    $object_ids Comma separated list if object IDs for which terms were retrieved.
+     * @param string    $taxonomies SQL fragment of taxonomy names from which terms were retrieved.
+     * @param array     $args       Array of arguments for retrieving terms for the given
+     *                              object(s). See wp_get_object_terms() for details.
      */
     return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );