From 0a2a18a63611c24f362a2b180a962b5981550736 Mon Sep 17 00:00:00 2001 From: Jb Audras Date: Fri, 24 Jan 2025 23:26:18 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@59704 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/category.php | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/category.php b/src/wp-includes/category.php index 5dc35cf6b5..d1c43274d7 100644 --- a/src/wp-includes/category.php +++ b/src/wp-includes/category.php @@ -85,8 +85,9 @@ function get_categories( $args = '' ) { * correspond to a WP_Term object, an associative array, or a numeric array, * 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' ) { $category = get_term( $category, 'category', $output, $filter );