Question

get_category( int|object $category,  string $output = OBJECT,  string $filter = 'raw' )

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.

The category will converted to maintain backward compatibility.

---

参数

$category

(int|object) (Required) Category ID or Category row object

$output

(string) (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 value: OBJECT

$filter

(string) (Optional) Default is raw or no WordPress defined filter will applied.

Default value: 'raw'

---

返回值

(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.

---

源代码

File: wp-includes/category.php

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;
}

---

更新日志

Version	description
1.5.1	Introduced.

---

相关函数

Uses

• wp-includes/category.php: _make_cat_compat()
• wp-includes/taxonomy.php: get_term()
• wp-includes/load.php: is_wp_error()

---

Used By

• wp-admin/includes/class-wp-press-this.php: WP_Press_This::add_category()
• wp-includes/deprecated.php: get_category_children()
• wp-includes/deprecated.php: get_linkcatname()

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Bruno Kos

   Perform a check if category with cat ID has any number of posts.

   
   if ( get_category( $id )->category_count > 1 ) {
      //do something
   }
   

Example passing Category ID (integer):

<?php $category = get_category( 106 ); ?>

The output of print_r( $category ); would be similar to:

stdClass Object
(
[term_id] => 106
[name] => Category Name
[slug] => category-name
[term_group] => 0
[term_taxonomy_id] => 108
[taxonomy] => category
[description] => This is the category description.
[parent] => 62
[count] => 17
[filter] => raw
[cat_ID] => 106
[category_count] => 17
[category_description] => This is the category description.
[cat_name] => Category Name
[category_nicename] => category-name
[category_parent] => 62
)


Get current category data on a category template:

$current_category = get_category( get_query_var( 'cat' ), false );