Changeset 59704

Timestamp:

01/24/2025 11:26:18 PM (5 months ago)

Author:

audrasjb

Message:

Docs: Improve @return docblock section for get_category().

This changeset adds more details on the WP_Term returned by get_category() as it contains additional backwards compatible aliases for the era before WP 4.4 and 2.3.

Props apermo, audrasjb.
Fixes #62842.
See #62281.

File:

• trunk/src/wp-includes/category.php (modified) (1 diff)

trunk/src/wp-includes/category.php

@@ -86 +86 @@
  *                             respectively. Default OBJECT.
  * @param string     $filter   Optional. How to sanitize category fields. Default 'raw'.
- * @return object|array|WP_Error|null Category data in type defined by $output parameter.
- *                                    WP_Error if $category is empty, null if it does not exist.
+ * @return WP_Term|array|WP_Error|null Category data in type defined by $output parameter.
+ *                                     Returns a WP_Term object with backwards compatible property aliases filled in.
+ *                                     WP_Error if $category is empty, null if it does not exist.
  */
 function get_category( $category, $output = OBJECT, $filter = 'raw' ) {