云策 WordPress 开发者社区

函数文档

get_taxonomies()

查看官方原文 ↗
💡 云策文档标注

概述

get_taxonomies() 函数用于检索已注册的分类法名称或对象列表。它通过参数过滤分类法，支持返回名称数组或对象数组，适用于 WordPress 开发中的分类法管理和查询场景。

关键要点

  • 函数返回已注册分类法的名称或对象数组，可通过 $output 参数控制输出类型（'names' 或 'objects'）。
  • 使用 $args 参数数组过滤分类法，匹配属性如 name、object_type、public 等，$operator 参数指定逻辑操作（'and' 或 'or'）。
  • 返回数组结构：名称数组为键值对（如 [special_taxonomy] => special_taxonomy），对象数组包含 hierarchical、labels、cap 等字段。
  • 函数内部调用 wp_filter_object_list() 实现过滤，自 WordPress 3.0.0 版本引入。

代码示例

// 示例：检索公共自定义分类法名称
$args = array(
  'public' => true,
  '_builtin' => false
);
$taxonomies = get_taxonomies( $args, 'names', 'and' );
if ( $taxonomies ) {
  echo '<ul>';
  foreach ( $taxonomies as $taxonomy ) {
    echo '<li>' . $taxonomy . '</li>';
  }
  echo '</ul>';
}

注意事项

  • 当 $args 包含 object_type 参数时，仅返回完全匹配该文章类型的分类法；若分类法关联多个文章类型，可能不被列出，建议使用 get_object_taxonomies() 替代。
  • 返回对象时，可通过 $taxonomy->labels->name 访问分类法标签，但需确保输出类型为 'objects'。
  • 函数在高级用例中可用于根据术语 slug 查找分类法，但需结合 get_term_by() 等函数。
📄 原文内容

Retrieves a list of registered taxonomy names or objects.

Parameters

$argsarrayoptional
An array of key => value arguments to match against the taxonomy objects.

Default:array()

$outputstringoptional
The type of output to return in the array. Either 'names' or 'objects'. Default 'names'.
$operatorstringoptional
The logical operation to perform. Accepts 'and' or 'or'. 'or' means only one element from the array needs to match; 'and' means all elements must match.
Default 'and'.

Return

string[]|WP_Taxonomy[] An array of taxonomy names or objects.

More Information

Parameter $args is an array of key -> value arguments to match against the taxonomies. Only taxonomies having attributes that match all arguments are returned.

  • name
  • object_type (array)
  • label
  • singular_label
  • show_ui
  • show_tagcloud
  • show_in_rest
  • public
  • update_count_callback
  • rewrite
  • query_var
  • manage_cap
  • edit_cap
  • delete_cap
  • assign_cap
  • _builtin

Returned value is an array, a list of taxonomy names or objects. If returning names, you will get an array of the taxonomy names such as

Array ( [special_taxonomy] => special_taxonomy [custom_taxonomy] => custom_taxonomy )

If returning objects, you will get an array of objects such as:

Array ( [special_taxonomy] => stdClass Object  [custom_taxonomy] => stdClass Object  )

wherein each object will contain the following fields:

stdClass Object ( 
[hierarchical] => 
[update_count_callback] =>  
[rewrite] => 
[query_var] => 
[public] => 
[show_ui] => 
[show_tagcloud] => 
[_builtin] => 
[labels] => stdClass Object ( 
	[name] =>  
	[singular_name] =>
	[search_items] => 
	[popular_items] => 
	[all_items] => 
	[parent_item] => 
	[parent_item_colon] =>  
	[edit_item] => 
	[view_item] =>  
	[update_item] => 
	[add_new_item] => 
	[new_item_name] => 
	[separate_items_with_commas] => 
	[add_or_remove_items] => 
	[choose_from_most_used] => 
	[menu_name] =>  
	[name_admin_bar] =>  ) 
[show_in_nav_menus] => 
[cap] => stdClass Object ( 
	[manage_terms] =>  
	[edit_terms] =>  
	[delete_terms] =>  
	[assign_terms] =>  ) 
[name] =>  
[object_type] => Array () 
[label]  )

Source

function get_taxonomies( $args = array(), $output = 'names', $operator = 'and' ) {
	global $wp_taxonomies;

	$field = ( 'names' === $output ) ? 'name' : false;

	return wp_filter_object_list( $wp_taxonomies, $args, $operator, $field );
}

View all references View on Trac View on GitHub

Uses Description
wp_filter_object_list()wp-includes/functions.php

Filters a list of objects, based on a set of key => value arguments.
Used by Description
get_template_hierarchy()wp-includes/block-template-utils.php

Gets the template hierarchy for the given template slug to be created.
_build_block_template_result_from_post()wp-includes/block-template-utils.php

Builds a unified template object based a post Object.
WP_REST_Term_Search_Handler::__construct()wp-includes/rest-api/search/class-wp-rest-term-search-handler.php

Constructor.
WP_Sitemaps_Taxonomies::get_object_subtypes()wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php

Returns all public, registered taxonomies.
create_initial_rest_routes()wp-includes/rest-api.php

Registers default REST API routes.
WP_REST_Taxonomies_Controller::get_items_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php

Checks whether a given request has permission to read taxonomies.
WP_REST_Taxonomies_Controller::get_items()wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php

Retrieves all public taxonomies.
WP_Customize_Nav_Menus::search_available_items_query()wp-includes/class-wp-customize-nav-menus.php

Performs post queries for available-item searching.
WP_Customize_Nav_Menus::available_item_types()wp-includes/class-wp-customize-nav-menus.php

Returns an array of all the available item types.
export_wp()wp-admin/includes/export.php

Generates the WXR export file for download.
set_screen_options()wp-admin/includes/misc.php

Saves option for number of rows when listing posts, pages, comments, etc.
wp_ajax_menu_get_metabox()wp-admin/includes/ajax-actions.php

Handles for retrieving menu meta boxes via AJAX.
wp_nav_menu_taxonomy_meta_boxes()wp-admin/includes/nav-menu.php

Creates meta boxes for any taxonomy menu item.
WP::parse_request()wp-includes/class-wp.php

Parses the request to find the correct WordPress query.
WP_Query::parse_tax_query()wp-includes/class-wp-query.php

Parses various taxonomy related query vars.
WP_Widget_Tag_Cloud::form()wp-includes/widgets/class-wp-widget-tag-cloud.php

Outputs the Tag Cloud widget settings form.
get_post_class()wp-includes/post-template.php

Retrieves an array of the class names for the post container element.
get_taxonomies_for_attachments()wp-includes/media.php

Retrieves all of the taxonomies that are registered for attachments.
wp_xmlrpc_server::wp_getTaxonomies()wp-includes/class-wp-xmlrpc-server.php

Retrieves all taxonomies.

Show 14 moreShow less

Changelog

Version Description
3.0.0 Introduced.

User Contributed Notes

  1. Skip to note 8 content


    hearvox


    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

    Display a list of only public custom taxonomies — will not list include WordPress built-in taxonomies (e.g., categories and tags):

     true,
  '_builtin' => false
  
); 
$output = 'names'; // or objects
$operator = 'and'; // 'and' or 'or'
$taxonomies = get_taxonomies( $args, $output, $operator ); 
if ( $taxonomies ) {
	echo '<ul>';
	foreach ( $taxonomies  as $taxonomy ) {
		echo '<li>' . $taxonomy . '</li>';
	}
	echo '</ul>';	
}
?>

  2. Skip to note 9 content


    Ulrich


    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    When querying the taxonomies with a specific post type like “posts” in this case, only the taxonomies connected only with this post type will be shown. If a taxonomy is attached to multiple post types it will not be listed. Core Trac Ticket 27918

     array(
		'post',
	),
);
$taxonomies = get_taxonomies( $args );

    The alternative is to use get_object_taxonomies().

  3. Skip to note 10 content


    hearvox


    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Display the plural name of a specific taxonomy (and setting the output to be 'object' rather than the default 'array‘):

     'genre'
);
$output = 'objects'; // or names
$taxonomies= get_taxonomies( $args, $output ); 
if ( $taxonomies ) {
	foreach ( $taxonomies as $taxonomy ) {
		echo '<div>' . $taxonomy->labels->name . '</div>';
	}
}  
?>

  5. Skip to note 12 content


    samjco


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    This can be used in certain use cases as if you need to find the taxonomy from a term slug

                    // We want to find the Taxonomy to this slug.
                $term_slug = 'myterm';
                $taxonomies = get_taxonomies();
                foreach ( $taxonomies as $tax_type_key => $taxonomy ) {
                    // If term object is returned, break out of loop. (Returns false if there's no object)
                    if ( $term_object = get_term_by( 'slug', $term_slug , $taxonomy ) ) {
                        break;
                    }
                }
				//Get the taxonomy!!
                echo $term_object->taxonomy . '<br>';

				// You can also retrieve other thing of the term:
                echo $term_object->name . '<br>'; //term name
                echo $term_object->term_id . '<br>'; // term id
                echo $term_object->description . '<br>'; // term description

				// See all options by dumping the $term_object:
				//var_dump( $term_object );

  7. Skip to note 14 content


    shewa12


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Get only public taxonomies by post type that are displayed on the admin nav menu

        $args       = array(
        'object_type' => array( 'post' ),
        'public'      => true,
        'show_ui'     => true,
    );
    $taxonomies = get_taxonomies( $args, 'object' );
    $response   = array();
    foreach ( $taxonomies as $taxonomy ) {
        array_push(
            $response,
            array(
                'name'  => $taxonomy->name,
                'label' => $taxonomy->label,
            )
        );
    }

    print_r( $response );

    The typical response will look like this:

    [
    {
        "name": "category",
        "label": "Categories"
    },
    {
        "name": "post_tag",
        "label": "Tags"
    }
]