get_categories()
云策文档标注
概述
get_categories() 函数用于检索分类对象列表,默认从 'category' 分类法中获取。它基于 get_terms() 实现,支持通过参数自定义查询,并包含向后兼容性和错误处理。
关键要点
- 函数返回分类对象数组,参数 $args 可选,可传递字符串或数组,默认 taxonomy 为 'category'。
- 通过设置 'taxonomy' 参数为 'link_category' 可检索链接分类,旧版 'type' => 'link' 已弃用。
- 内部使用 get_terms() 执行查询,支持 WP_Term_Query 的所有参数,如 'hide_empty'、'parent' 等。
- 包含过滤器 get_categories_taxonomy 用于修改分类法,错误时返回空数组,并调用 _make_cat_compat() 保持兼容性。
- 默认仅返回有文章的分类,需设置 'hide_empty' => false 以包含未使用分类。
代码示例
// 示例:获取所有分类(包括未使用的)
$args = array(
'hide_empty' => false,
);
$categories = get_categories($args);
// 示例:获取顶级分类
$categories = get_categories(array(
'orderby' => 'name',
'parent' => 0
));
// 示例:递归获取子分类
function wpdocs_get_child_categories($parent_category_id) {
$html = '';
$child_categories = get_categories(array('parent' => $parent_category_id, 'hide_empty' => false));
if (!empty($child_categories)) {
$html .= '<ul>';
foreach ($child_categories as $child_category) {
$html .= '<li>' . $child_category->name;
$html .= wpdocs_get_child_categories($child_category->term_id);
$html .= '</li>';
}
$html .= '</ul>';
}
return $html;
}注意事项
- 函数自 WordPress 2.1.0 引入,无分类时返回空数组。
- 参数传递需参考 get_terms() 和 WP_Term_Query,确保正确设置查询条件。
- 使用 esc_url() 和 esc_html() 等函数处理输出以提高安全性。
原文内容
Retrieves a list of category objects.
Description
If you set the ‘taxonomy’ argument to ‘link_category’, the link categories will be returned instead.
See also
- get_terms(): Type of arguments that can be changed.
Parameters
$argsstring|arrayoptional-
Arguments to retrieve categories. See get_terms() for additional options.
taxonomystringTaxonomy to retrieve terms for. Default'category'.
More Arguments from get_terms( … $args )
Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments.
Source
function get_categories( $args = '' ) {
$defaults = array( 'taxonomy' => 'category' );
$args = wp_parse_args( $args, $defaults );
/**
* Filters the taxonomy used to retrieve terms when calling get_categories().
*
* @since 2.7.0
*
* @param string $taxonomy Taxonomy to retrieve terms from.
* @param array $args An array of arguments. See get_terms().
*/
$args['taxonomy'] = apply_filters( 'get_categories_taxonomy', $args['taxonomy'], $args );
// Back compat.
if ( isset( $args['type'] ) && 'link' === $args['type'] ) {
_deprecated_argument(
__FUNCTION__,
'3.0.0',
sprintf(
/* translators: 1: "type => link", 2: "taxonomy => link_category" */
__( '%1$s is deprecated. Use %2$s instead.' ),
'<code>type => link</code>',
'<code>taxonomy => link_category</code>'
)
);
$args['taxonomy'] = 'link_category';
}
$categories = get_terms( $args );
if ( is_wp_error( $categories ) ) {
$categories = array();
} else {
$categories = (array) $categories;
foreach ( array_keys( $categories ) as $k ) {
_make_cat_compat( $categories[ $k ] );
}
}
return $categories;
}
Hooks
- apply_filters( ‘get_categories_taxonomy’, string $taxonomy, array $args )
-
Filters the taxonomy used to retrieve terms when calling get_categories() .
Changelog
| Version | Description |
|---|---|
| 2.1.0 | Introduced. |
Skip to note 9 content
Codex
List Categories and Descriptions
This example will list, in alphabetic order, all categories presented as links to the corresponding category archive. Each category description is listed after the category link.
'name', 'order' => 'ASC' ) ); foreach( $categories as $category ) { $category_link = sprintf( '<a href="%1$s" alt="%2$s">%3$s</a>', esc_url( get_category_link( $category->term_id ) ), esc_attr( sprintf( __( 'View all posts in %s', 'textdomain' ), $category->name ) ), esc_html( $category->name ) ); echo '<p>' . sprintf( esc_html__( 'Category: %s', 'textdomain' ), $category_link ) . '</p> '; echo '<p>' . sprintf( esc_html__( 'Description: %s', 'textdomain' ), $category->description ) . '</p>'; echo '<p>' . sprintf( esc_html__( 'Post Count: %s', 'textdomain' ), $category->count ) . '</p>'; }Skip to note 10 content
isMike()
Function only returns categories in use by posts
It is very important to note that by default, the
get_category()will ONLY return categories that ARE IN USE. This means if no post is assigned to the category, then the category object for that category is not returned.This means if you are developer, and you created a category (maybe during testing), you should supply an argument array having the
'hide_empty' => falsein it. Check the example usage below.$args = array( 'hide_empty' => false, ); get_categories($args); //This returns both used and unused categoriesSkip to note 11 content
Codex
Get only top level categories
To get the top level categories only, set parent value to zero. This example gets link and name of top level categories.
$categories = get_categories( array( 'orderby' => 'name', 'parent' => 0 ) ); foreach ( $categories as $category ) { printf( '<a href="%1$s">%2$s</a><br />', esc_url( get_category_link( $category->term_id ) ), esc_html( $category->name ) ); }Skip to note 12 content
boundless_ink
Specific category parent title with linked menu of subcategories
– could be used in a sidebar application
<div class="category-menu-container"> <ul class="category-menu"> <li class="unstyled"> <h4 class="category-menu-heading"> </h4> </li> 'name', 'order' => 'ASC', 'parent' => 130, ) ); foreach( $categories as $category ) { $category_link = sprintf( '<a href="%1$s" alt="%2$s">%3$s</a>', esc_url( get_category_link( $category->term_id ) ), esc_attr( sprintf( __( 'View all posts in %s', 'textdomain' ), $category->name ) ), esc_html( $category->name ) ); echo '<p>' . sprintf( esc_html__( '%s', 'textdomain' ), $category_link ) . '</p> '; } ?> </ul> </div>Skip to note 13 content
cameronamcintyre
If there are no categories to display,
get_categories()will return an empty array.Skip to note 14 content
Ahir Hemant
get all parent categories, and then based on parent id you can write a recurring function that gives you the child category of given id.
function wpdocs_get_child_categories( $parent_category_id ) { $html = ''; $child_categories = get_categories( array( 'parent' => $parent_category_id, 'hide_empty' => false, 'taxonomy' => $taxonomy ) ); if ( ! empty( $child_categories ) ) { $html .= '<ul>'; foreach ( $child_categories as $child_category ) { $html .= '<li>'.$child_category->name; $html .= get_child_categories( $child_category->term_id ); $html .= '</li>'; } $html .= '</ul>'; } return $html; } function wpdocs_list_categories() { $html = ''; $parent_categories = get_categories( array( 'parent' => 0, 'hide_empty' => false, 'taxonomy' => $taxonomy ) ); $html .= '<ul>'; foreach ( $parent_categories as $parent_category ) { $html .= '<li>'; $html .= $parent_category->name; $html .= wpdocs_get_child_categories( $parent_category->term_id ); $html .= '</li>'; } $html.= '</ul>'; return $html; } add_shortcode( 'wpdocs_list_categories', 'wpdocs_list_categories' );Output look like this:
A – Main category
B – Child Category
C – Child Category
D – Nested Child Category( if available )
E – Main category
F – Child Category
G – Child Category
H – Nested Child Category( if available )
Skip to note 15 content
Codex
Drop-down box as used in Parent category at post category page
This is the code used in the built-in category page.
wp_dropdown_categories( array( 'hide_empty' => 0, 'name' => 'category_parent', 'orderby' => 'name', 'selected' => $category->parent, 'hierarchical' => true, 'show_option_none' => __('None') ) );The slightly altered code below will grab all categories and display them with indent for a new level (child category). The select box will have name and id attribute values of ‘select_name’. This select element will not display a default “none” as the original code was used to attach a category as a child to another category (or none).
wp_dropdown_categories( array( 'hide_empty' => 0, 'name' => 'select_name', 'id' => 'select_name', 'hierarchical' => true ) );Skip to note 16 content
Codex
Drop-down Box
Here’s how to create a drop-down box of the subcategories of, say, a category that archives information on past events.
This mirrors the example of the drop-down example of
<a href="https://developer.wordpress.org/reference/functions/wp_get_archives/">wp_get_archives()</a>which shows how to create a drop-down box for monthly archives.Suppose the category whose subcategories you want to show is category 10, and that its category “nicename” is “archives”.
<select name="event-dropdown"> <option value=""></option> 10 ) ); foreach ( $categories as $category ) { printf( '<option value="%1$s">%2$s (%3$s)</option>', esc_attr( '/category/archives/' . $category->category_nicename ), esc_html( $category->cat_name ), esc_html( $category->category_count ) ); } ?> </select>