get_taxonomy_labels( WP_Taxonomy $tax ): object
Builds an object with all taxonomy labels out of a taxonomy object.
Parameters
-
$tax
WP_Taxonomy Required -
Taxonomy object.
Return
object Taxonomy labels object. The first default value is for non-hierarchical taxonomies (like tags) and the second one is for hierarchical taxonomies (like categories).
name
stringGeneral name for the taxonomy, usually plural. The same as and overridden by$tax->label
. Default'Tags'
/'Categories'
.singular_name
stringName for one object of this taxonomy. Default'Tag'
/'Category'
.search_items
stringDefault 'Search Tags'/'
Search Categories'.popular_items
stringThis label is only used for non-hierarchical taxonomies.
Default 'Popular Tags'.all_items
stringDefault 'All Tags'/'
All Categories'.parent_item
stringThis label is only used for hierarchical taxonomies. Default 'Parent Category'.parent_item_colon
stringThe same asparent_item
, but with colon:
in the end.name_field_description
stringDescription for the Name field on Edit Tags screen.
Default 'The name is how it appears on your site'.slug_field_description
stringDescription for the Slug field on Edit Tags screen.
Default 'The “slug” is the URL-friendly version of the name. It is usually all lowercase and contains only letters, numbers, and hyphens'.parent_field_description
stringDescription for the Parent field on Edit Tags screen.
Default 'Assign a parent term to create a hierarchy.
The term Jazz, for example, would be the parent of Bebop and Big Band'.desc_field_description
stringDescription for the Description field on Edit Tags screen.
Default 'The description is not prominent by default; however, some themes may show it'.edit_item
stringDefault 'Edit Tag'/'
Edit Category'.view_item
stringDefault 'View Tag'/'
View Category'.update_item
stringDefault 'Update Tag'/'
Update Category'.add_new_item
stringDefault 'Add New Tag'/'
Add New Category'.new_item_name
stringDefault 'New Tag Name'/'
New Category Name'.separate_items_with_commas
stringThis label is only used for non-hierarchical taxonomies. Default 'Separate tags with commas', used in the meta box.add_or_remove_items
stringThis label is only used for non-hierarchical taxonomies. Default 'Add or remove tags', used in the meta box when JavaScript is disabled.choose_from_most_used
stringThis label is only used on non-hierarchical taxonomies. Default 'Choose from the most used tags', used in the meta box.not_found
stringDefault 'No tags found'/'
No categories found', used in the meta box and taxonomy list table.no_terms
stringDefault 'No tags'/'
No categories', used in the posts and media list tables.filter_by_item
stringThis label is only used for hierarchical taxonomies. Default 'Filter by category', used in the posts list table.items_list_navigation
stringLabel for the table pagination hidden heading.items_list
stringLabel for the table hidden heading.most_used
stringTitle for the Most Used tab. Default 'Most Used'.back_to_items
stringLabel displayed after a term has been updated.item_link
stringUsed in the block editor. Title for a navigation link block variation.
Default 'Tag Link'/'
Category Link'.item_link_description
stringUsed in the block editor. Description for a navigation link block variation. Default 'A link to a tag'/'
A link to a category'.
Source
File: wp-includes/taxonomy.php
.
View all references
function get_taxonomy_labels( $tax ) {
$tax->labels = (array) $tax->labels;
if ( isset( $tax->helps ) && empty( $tax->labels['separate_items_with_commas'] ) ) {
$tax->labels['separate_items_with_commas'] = $tax->helps;
}
if ( isset( $tax->no_tagcloud ) && empty( $tax->labels['not_found'] ) ) {
$tax->labels['not_found'] = $tax->no_tagcloud;
}
$nohier_vs_hier_defaults = WP_Taxonomy::get_default_labels();
$nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
$labels = _get_custom_object_labels( $tax, $nohier_vs_hier_defaults );
$taxonomy = $tax->name;
$default_labels = clone $labels;
/**
* Filters the labels of a specific taxonomy.
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `taxonomy_labels_category`
* - `taxonomy_labels_post_tag`
*
* @since 4.4.0
*
* @see get_taxonomy_labels() for the full list of taxonomy labels.
*
* @param object $labels Object with labels for the taxonomy as member variables.
*/
$labels = apply_filters( "taxonomy_labels_{$taxonomy}", $labels );
// Ensure that the filtered labels contain all required default values.
$labels = (object) array_merge( (array) $default_labels, (array) $labels );
return $labels;
}
Hooks
-
apply_filters( "taxonomy_labels_{$taxonomy}",
object $labels ) -
Filters the labels of a specific taxonomy.
Changelog
Version | Description |
---|---|
5.9.0 | Added the name_field_description , slug_field_description , parent_field_description , and desc_field_description labels. |
5.8.0 | Added the item_link and item_link_description labels. |
5.7.0 | Added the filter_by_item label. |
4.9.0 | Added the most_used and back_to_items labels. |
4.4.0 | Added the items_list_navigation and items_list labels. |
4.3.0 | Added the no_terms label. |
3.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
The return object also includes a `menu_name` property (defaults to `name` property), which is used for the tab in the admin menu.