On this page
get_category( int|object $category, string $output = OBJECT, string $filter = 'raw' ): object|array|WP_Error|null
Retrieves category data given a category ID or category object.
Description
If you pass the $category parameter an object, which is assumed to be the category row object retrieved the database. It will cache the category data.
If you pass $category an integer of the category ID, then that category will be retrieved from the database, if it isn’t already cached, and pass it back.
If you look at get_term() , then both types will be passed through several filters and finally sanitized based on the $filter parameter value.
Parameters
$categoryint|object Required-
Category ID or category row object.
$outputstring Optional-
The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Term object, an associative array, or a numeric array, respectively.
Default:
OBJECT $filterstring Optional-
How to sanitize category fields. Default
'raw'.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.
Source
File: wp-includes/category.php. View all references
function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
$category = get_term( $category, 'category', $output, $filter );
if ( is_wp_error( $category ) ) {
return $category;
}
_make_cat_compat( $category );
return $category;
}
Related
Uses
| Uses | Description |
|---|---|
| _make_cat_compat() wp-includes/category.php | Updates category structure to old pre-2.3 from new taxonomy structure. |
| get_term() wp-includes/taxonomy.php | Gets all term data from database by term ID. |
| is_wp_error() wp-includes/load.php | Checks whether the given variable is a WordPress Error. |
Used By
| Used By | Description |
|---|---|
| get_category_children() wp-includes/deprecated.php | Retrieve category children list separated before and after the term IDs. |
| get_linkcatname() wp-includes/deprecated.php | Gets the name of category by ID. |
Changelog
| Version | Description |
|---|---|
| 1.5.1 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_category