get_taxonomy_labels( WP_Taxonomy $tax ): object

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$taxWP_Taxonomy

Taxonomy object.

Return value

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).

• $namestring

  General name for the taxonomy, usually plural. The same as and overridden by $tax->label. Default 'Tags'/'Categories'.

• $singular_namestring

  Name for one object of this taxonomy. Default 'Tag'/'Category'.

• $search_itemsstring

  Default 'Search Tags'/'Search Categories'.

• $popular_itemsstring

  This label is only used for non-hierarchical taxonomies. Default 'Popular Tags'.

• $all_itemsstring

  Default 'All Tags'/'All Categories'.

• $parent_itemstring

  This label is only used for hierarchical taxonomies. Default 'Parent Category'.

• $parent_item_colonstring

  The same as parent_item, but with colon : in the end.

• $name_field_descriptionstring

  Description for the Name field on Edit Tags screen. Default 'The name is how it appears on your site'.

• $slug_field_descriptionstring

  Description 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_descriptionstring

  Description 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_descriptionstring

  Description for the Description field on Edit Tags screen. Default 'The description is not prominent by default; however, some themes may show it'.

• $edit_itemstring

  Default 'Edit Tag'/'Edit Category'.

• $view_itemstring

  Default 'View Tag'/'View Category'.

• $update_itemstring

  Default 'Update Tag'/'Update Category'.

• $add_new_itemstring

  Default 'Add Tag'/'Add Category'.

• $new_item_namestring

  Default 'New Tag Name'/'New Category Name'.

• $template_namestring

  Default 'Tag Archives'/'Category Archives'.

• $separate_items_with_commasstring

  This label is only used for non-hierarchical taxonomies. Default 'Separate tags with commas', used in the meta box.

• $add_or_remove_itemsstring

  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_usedstring

  This label is only used on non-hierarchical taxonomies. Default 'Choose from the most used tags', used in the meta box.

• $not_foundstring

  Default 'No tags found'/'No categories found', used in the meta box and taxonomy list table.

• $no_termsstring

  Default 'No tags'/'No categories', used in the posts and media list tables.

• $filter_by_itemstring

  This label is only used for hierarchical taxonomies. Default 'Filter by category', used in the posts list table.

• $items_list_navigationstring

  Label for the table pagination hidden heading.

• $items_liststring

  Label for the table hidden heading.

• $most_usedstring

  Title for the Most Used tab. Default 'Most Used'.

• $back_to_itemsstring

  Label displayed after a term has been updated.

• $item_linkstring

  Used in the block editor. Title for a navigation link block variation. Default 'Tag Link'/'Category Link'.

• $item_link_descriptionstring

  Used in the block editor. Description for a navigation link block variation. Default 'A link to a tag'/'A link to a category'.

Performance profile

How much work a call to get_taxonomy_labels() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

40–67

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 67.

Plugin surface

1 hook

Third-party callbacks on 'taxonomy_labels_{$taxonomy}' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_taxonomy_labels() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_taxonomy_labels() runs, in this order:

1. 1
   apply_filters( taxonomy_labels_{$taxonomy} )filterline 749 (+42 into the body)

   Filters the labels of a specific taxonomy.

Uses · 4

• _get_custom_object_labels()Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object
• _x()Retrieves translated string with gettext context.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Taxonomy::get_default_labels()Returns the default labels for taxonomies.

Used by · 1

• WP_Taxonomy::set_props()Sets taxonomy properties.

Source code

View on Trac ↗View on GitHub ↗

707function get_taxonomy_labels( $tax ) {708	$tax->labels = (array) $tax->labels;709 710	if ( isset( $tax->helps ) && empty( $tax->labels['separate_items_with_commas'] ) ) {711		$tax->labels['separate_items_with_commas'] = $tax->helps;712	}713 714	if ( isset( $tax->no_tagcloud ) && empty( $tax->labels['not_found'] ) ) {715		$tax->labels['not_found'] = $tax->no_tagcloud;716	}717 718	$nohier_vs_hier_defaults = WP_Taxonomy::get_default_labels();719 720	$nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];721 722	$labels = _get_custom_object_labels( $tax, $nohier_vs_hier_defaults );723 724	if ( ! isset( $tax->labels->template_name ) && isset( $labels->singular_name ) ) {725		/* translators: %s: Taxonomy name. */726		$labels->template_name = sprintf( _x( '%s Archives', 'taxonomy template name' ), $labels->singular_name );727	}728 729	$taxonomy = $tax->name;730 731	$default_labels = clone $labels;732 733	/**734	 * Filters the labels of a specific taxonomy.735	 *736	 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.737	 *738	 * Possible hook names include:739	 *740	 *  - `taxonomy_labels_category`741	 *  - `taxonomy_labels_post_tag`742	 *743	 * @since 4.4.0744	 *745	 * @see get_taxonomy_labels() for the full list of taxonomy labels.746	 *747	 * @param object $labels Object with labels for the taxonomy as member variables.748	 */749	$labels = apply_filters( "taxonomy_labels_{$taxonomy}", $labels );750 751	// Ensure that the filtered labels contain all required default values.752	$labels = (object) array_merge( (array) $default_labels, (array) $labels );753 754	return $labels;755}

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.