在 WordPress 中,get_taxonomy_labels() 函数用于获取指定分类法(taxonomy)的标签(labels)。这些标签用于在管理界面中显示分类法的相关文本,例如“添加新项目”、“编辑项目”等。下面详细说明 get_taxonomy_labels() 的使用方法及其输出内容。
1. 函数说明
函数名: get_taxonomy_labels()
参数:
- $taxonomy: 一个 WP_Taxonomy 对象或分类法名称(字符串)。
返回值: 一个包含分类法标签的 stdClass 对象。
2. 输出内容
get_taxonomy_labels() 返回的对象包含多个属性,每个属性对应一个管理界面中的文本标签。以下是一些常见的标签及其默认值(如果未自定义):
- name: 分类法的通用名称,通常是复数形式。
默认值: 例如,对于分类(category),默认值为 "Categories"。 - singular_name: 分类法的单数名称。
默认值: 例如,对于分类(category),默认值为 "Category"。 - search_items: 搜索项目的标签。
默认值: "Search Categories" - popular_items: 常用项目的标签。
默认值: "Popular Categories" - all_items: 所有项目的标签。
默认值: "All Categories" - parent_item: 父项目的标签。
默认值: "Parent Category" - parent_item_colon: 父项目的标签,带冒号。
默认值: "Parent Category:" - edit_item: 编辑项目的标签。
默认值: "Edit Category" - view_item: 查看项目的标签。
默认值: "View Category" - update_item: 更新项目的标签。
默认值: "Update Category" - add_new_item: 添加新项目的标签。
默认值: "Add New Category" - new_item_name: 新项目名称的标签。
默认值: "New Category Name" - separate_items_with_commas: 使用逗号分隔项目的标签。
默认值: "Separate categories with commas" - add_or_remove_items: 添加或移除项目的标签。
默认值: "Add or remove categories" - choose_from_most_used: 从最常用的项目中选择的标签。
默认值: "Choose from the most used categories" - menu_name: 管理菜单中的名称。
默认值: "Categories" - not_found: 未找到项目的标签。
默认值: "No categories found." - no_terms: 没有项目的标签。
默认值: "No categories" - items_list_navigation: 项目列表导航的标签。
默认值: "Categories list navigation" - items_list: 项目列表的标签。
默认值: "Categories list"
3. 示例代码
以下是一个示例,展示如何使用 get_taxonomy_labels() 获取并输出分类法的标签:
// 获取分类法对象
$taxonomy = get_taxonomy('category');
// 获取分类法的标签
$labels = get_taxonomy_labels($taxonomy);
// 输出标签
foreach ($labels as $key => $label) {
echo "<strong>$key:</strong> $label<br>";
}
4. 自定义标签
在注册分类法时,可以通过 labels 参数自定义这些标签。例如:
register_taxonomy('custom_taxonomy', 'post', array(
'labels' => array(
'name' => __('Custom Taxonomies'),
'singular_name' => __('Custom Taxonomy'),
'search_items' => __('Search Custom Taxonomies'),
'all_items' => __('All Custom Taxonomies'),
'parent_item' => __('Parent Custom Taxonomy'),
'parent_item_colon' => __('Parent Custom Taxonomy:'),
'edit_item' => __('Edit Custom Taxonomy'),
'update_item' => __('Update Custom Taxonomy'),
'add_new_item' => __('Add New Custom Taxonomy'),
'new_item_name' => __('New Custom Taxonomy Name'),
'menu_name' => __('Custom Taxonomies'),
),
'hierarchical' => true,
));
通过自定义这些标签,可以更好地适应特定的业务需求和用户体验。
5. 总结
get_taxonomy_labels() 是一个非常有用的函数,可以帮助开发者获取和自定义分类法在管理界面中的文本标签。通过合理使用和自定义这些标签,可以提升用户体验和管理界面的可读性。