get_taxonomy_labels
Builds an object with all taxonomy labels out of a taxonomy object.
Description
(object) get_taxonomy_labels( (WP_Taxonomy) $tax );
Accepted keys of the label array in the taxonomy object:
- name - general name for the taxonomy, usually plural. The same as and overridden by $tax
->label. Default is Tags/Categories - singular_name - name for one object of this taxonomy. Default is Tag/Category - search_items - Default is Search Tags/Search Categories - popular_items - This string isn't used on hierarchical taxonomies. Default is Popular Tags - all_items - Default is All Tags/All Categories - parent_item - This string isn't used on non-hierarchical taxonomies. In hierarchical ones the default is Parent Category - parent_item_colon - The same as parent_item,, but with colon : in the end - edit_item - Default is Edit Tag/Edit Category - view_item - Default is View Tag/View Category - update_item - Default is Update Tag/Update Category - add_new_item - Default is Add New Tag/Add New Category - new_item_name - Default is New Tag Name/New Category Name - separate_items_with_commas - This string isn't used on hierarchical taxonomies. Default is Separate tags with commas, used in the meta box. - add_or_remove_items - This string isn't used on hierarchical taxonomies. Default is Add or remove tags, used in the meta box when JavaScript is disabled. - choose_from_most_used - This string isn't used on hierarchical taxonomies. Default is Choose from the most used tags, used in the meta box. - not_found - Default is No tags found/"No categories found", used in the meta box and taxonomy list table. - no_terms - Default is No tags/"No categories", used in the posts and media list tables. - items_list_navigation - String for the table pagination hidden heading. - items_list - String for the table hidden heading.
Above, the first default value is for non-hierarchical taxonomies (like tags) and the second one is for hierarchical taxonomies (like categories).
Returns (object)
object with all the labels as member variables.
Parameters (1)
- 0. $tax (WP_Taxonomy)
- Taxonomy object.
Usage
if ( !function_exists( 'get_taxonomy_labels' ) ) { require_once ABSPATH . WPINC . '/taxonomy.php'; } // Taxonomy object. $tax = null; // NOTICE! Understand what this does before running. $result = get_taxonomy_labels($tax);
Defined (1)
The function is defined in the following location(s).
- /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(
- 'popular_items' => array( __( 'Popular Tags' ), null ),
- 'parent_item' => array( null, __( 'Parent Category' ) ),
- 'parent_item_colon' => array( null, __( 'Parent Category:' ) ),
- '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 ),
- );
- $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 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;
- }