{"id":23141,"date":"2016-12-06T18:19:22","date_gmt":"2016-12-06T18:19:22","guid":{"rendered":"https:\/\/developer.wordpress.org\/?post_type=rest-api-handbook&p=23141"},"modified":"2024-01-16T20:30:17","modified_gmt":"2024-01-16T20:30:17","slug":"taxonomies","status":"publish","type":"rest-api-handbook","link":"https:\/\/developer.wordpress.org\/rest-api\/reference\/taxonomies\/","title":{"rendered":"Taxonomies"},"content":{"rendered":"
\n
\n

Schema<\/h2>\n

The schema defines all the fields that exist within a taxonomy record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
\n capabilities<\/code>\n <\/td>\n\n All capabilities used by the taxonomy.<\/p>\n

\n JSON data type: object <\/p>\n

Read only<\/p>\n

Context: edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n description<\/code>\n <\/td>\n\n A human-readable description of the taxonomy.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n hierarchical<\/code>\n <\/td>\n\n Whether or not the taxonomy should have children.<\/p>\n

\n JSON data type: boolean <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n labels<\/code>\n <\/td>\n\n Human-readable labels for the taxonomy for various contexts.<\/p>\n

\n JSON data type: object <\/p>\n

Read only<\/p>\n

Context: edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n name<\/code>\n <\/td>\n\n The title for the taxonomy.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n slug<\/code>\n <\/td>\n\n An alphanumeric identifier for the taxonomy.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n show_cloud<\/code>\n <\/td>\n\n Whether or not the term cloud should be displayed.<\/p>\n

\n JSON data type: boolean <\/p>\n

Read only<\/p>\n

Context: edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n types<\/code>\n <\/td>\n\n Types associated with the taxonomy.<\/p>\n

\n JSON data type: array <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code><\/p>\n<\/td>\n<\/tr>\n

\n rest_base<\/code>\n <\/td>\n\n REST base route for the taxonomy.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n rest_namespace<\/code>\n <\/td>\n\n REST namespace route for the taxonomy.<\/p>\n

\n JSON data type: string <\/p>\n

Read only<\/p>\n

Context: view<\/code>, edit<\/code>, embed<\/code><\/p>\n<\/td>\n<\/tr>\n

\n visibility<\/code>\n <\/td>\n\n The visibility settings for the taxonomy.<\/p>\n

\n JSON data type: object <\/p>\n

Read only<\/p>\n

Context: edit<\/code><\/p>\n<\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n

\n
\n
\n

Retrieve a Taxonomy<\/h2>\n

Definition & Example Request<\/h3>\n

GET \/wp\/v2\/taxonomies<\/code><\/p>\n

Query this endpoint to retrieve a specific taxonomy record.<\/p>\n

$ curl https:\/\/example.com\/wp-json\/wp\/v2\/taxonomies<\/code>\n <\/div>\n

\n

Arguments<\/h3>\n\n\n\n
\n context<\/code>\n <\/td>\n\n Scope under which the request is made; determines fields present in response.<\/p>\n

\n Default: view<\/code>\n <\/p>\n

One of: view<\/code>, embed<\/code>, edit<\/code>\n <\/td>\n<\/tr>\n

\n type<\/code>\n <\/td>\n\n Limit results to taxonomies associated with a specific post type.\n <\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n
\n
\n

Retrieve a Taxonomy<\/h2>\n

Definition & Example Request<\/h3>\n

GET \/wp\/v2\/taxonomies\/<taxonomy><\/code><\/p>\n

Query this endpoint to retrieve a specific taxonomy record.<\/p>\n

$ curl https:\/\/example.com\/wp-json\/wp\/v2\/taxonomies\/<taxonomy><\/code>\n <\/div>\n

\n

Arguments<\/h3>\n\n\n\n
\n taxonomy<\/code>\n <\/td>\n\n An alphanumeric identifier for the taxonomy.\n <\/td>\n<\/tr>\n
\n context<\/code>\n <\/td>\n\n Scope under which the request is made; determines fields present in response.<\/p>\n

\n Default: view<\/code>\n <\/p>\n

One of: view<\/code>, embed<\/code>, edit<\/code>\n <\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n<\/div>\n","protected":false},"author":14582129,"featured_media":0,"parent":23078,"menu_order":0,"template":"","meta":{"_crdt_document":"","footnotes":""},"class_list":["post-23141","rest-api-handbook","type-rest-api-handbook","status-publish","hentry","type-handbook"],"revision_note":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23141","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook"}],"about":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/types\/rest-api-handbook"}],"author":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/users\/14582129"}],"version-history":[{"count":10,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23141\/revisions"}],"predecessor-version":[{"id":152000,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23141\/revisions\/152000"}],"up":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23078"}],"wp:attachment":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/media?parent=23141"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}