get_taxonomy_labels( WP_Taxonomy $tax )
Builds an object with all taxonomy labels out of a taxonomy object.
Parameters
- $tax
-
(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'
(string) General name for the taxonomy, usually plural. The same as and overridden by$tax->label
. Default 'Tags'/'Categories'. - 'singular_name'
(string) Name for one object of this taxonomy. Default 'Tag'/'Category'. - 'search_items'
(string) Default 'Search Tags'/'Search Categories'. - 'popular_items'
(string) This label is only used for non-hierarchical taxonomies. Default 'Popular Tags'. - 'all_items'
(string) Default 'All Tags'/'All Categories'. - 'parent_item'
(string) This label is only used for hierarchical taxonomies. Default 'Parent Category'. - 'parent_item_colon'
(string) The same asparent_item
, but with colon:
in the end. - 'edit_item'
(string) Default 'Edit Tag'/'Edit Category'. - 'view_item'
(string) Default 'View Tag'/'View Category'. - 'update_item'
(string) Default 'Update Tag'/'Update Category'. - 'add_new_item'
(string) Default 'Add New Tag'/'Add New Category'. - 'new_item_name'
(string) Default 'New Tag Name'/'New Category Name'. - 'separate_items_with_commas'
(string) This label is only used for non-hierarchical taxonomies. Default 'Separate tags with commas', used in the meta box. - 'add_or_remove_items'
(string) This 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'
(string) This label is only used on non-hierarchical taxonomies. Default 'Choose from the most used tags', used in the meta box. - 'not_found'
(string) Default 'No tags found'/'No categories found', used in the meta box and taxonomy list table. - 'no_terms'
(string) Default 'No tags'/'No categories', used in the posts and media list tables. - 'items_list_navigation'
(string) Label for the table pagination hidden heading. - 'items_list'
(string) Label for the table hidden heading. - 'most_used'
(string) Title for the Most Used tab. Default 'Most Used'. - 'back_to_items'
(string) Label displayed after a term has been updated.
Source
File: wp-includes/taxonomy.php
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 = array(
'name' => array( _x( 'Tags', 'taxonomy general name' ), _x( 'Categories', 'taxonomy general name' ) ),
'singular_name' => array( _x( 'Tag', 'taxonomy singular name' ), _x( 'Category', 'taxonomy singular name' ) ),
'search_items' => array( __( 'Search Tags' ), __( 'Search Categories' ) ),
'popular_items' => array( __( 'Popular Tags' ), null ),
'all_items' => array( __( 'All Tags' ), __( 'All Categories' ) ),
'parent_item' => array( null, __( 'Parent Category' ) ),
'parent_item_colon' => array( null, __( 'Parent Category:' ) ),
'edit_item' => array( __( 'Edit Tag' ), __( 'Edit Category' ) ),
'view_item' => array( __( 'View Tag' ), __( 'View Category' ) ),
'update_item' => array( __( 'Update Tag' ), __( 'Update Category' ) ),
'add_new_item' => array( __( 'Add New Tag' ), __( 'Add New Category' ) ),
'new_item_name' => array( __( 'New Tag Name' ), __( 'New Category Name' ) ),
'separate_items_with_commas' => array( __( 'Separate tags with commas' ), null ),
'add_or_remove_items' => array( __( 'Add or remove tags' ), null ),
'choose_from_most_used' => array( __( 'Choose from the most used tags' ), null ),
'not_found' => array( __( 'No tags found.' ), __( 'No categories found.' ) ),
'no_terms' => array( __( 'No tags' ), __( 'No categories' ) ),
'items_list_navigation' => array( __( 'Tags list navigation' ), __( 'Categories list navigation' ) ),
'items_list' => array( __( 'Tags list' ), __( 'Categories list' ) ),
/* translators: Tab heading when selecting from the most used terms */
'most_used' => array( _x( 'Most Used', 'tags' ), _x( 'Most Used', 'categories' ) ),
'back_to_items' => array( __( '← Back to Tags' ), __( '← Back to Categories' ) ),
);
$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.
*
* @since WP-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;
}
Changelog
Version | Description |
---|---|
WP-4.9.0 | Added the most_used and back_to_items labels. |
WP-4.4.0 | Added the items_list_navigation and items_list labels. |
WP-4.3.0 | Added the no_terms label. |
WP-3.0.0 | Introduced. |