Tags 
Edit
Topics
Schema Schema
The schema defines all the fields that exist for a tag object.
idinteger |
Unique identifier for the term.
Read only Context: |
countinteger |
Number of published posts for the term.
Read only Context: |
descriptionstring |
HTML description of the term.
Context: |
linkstring, uri |
URL of the term.
Read only Context: |
namestring |
HTML title for the term.
Context: |
slugstring |
An alphanumeric identifier for the term unique to its type.
Context: |
taxonomystring |
Type attribution for the term.
Read only Context: One of: |
metaobject |
Meta fields.
Context: |
Example Request Example Request
$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/tags
List Tags List Tags
Arguments Arguments
context
|
Scope under which the request is made; determines fields present in response.
Default: One of: |
page
|
Current page of the collection.
Default: |
per_page
|
Maximum number of items to be returned in result set.
Default: |
search
|
Limit results to those matching a string. |
exclude
|
Ensure result set excludes specific IDs. |
include
|
Limit result set to specific IDs. |
offset
|
Offset the result set by a specific number of items. |
order
|
Order sort attribute ascending or descending.
Default: One of: |
orderby
|
Sort collection by term attribute.
Default: One of: |
hide_empty
|
Whether to hide terms not assigned to any posts. |
post
|
Limit result set to terms assigned to a specific post. |
slug
|
Limit result set to terms with one or more specific slugs. |
Definition Definition
GET /wp/v2/tags
Example Request Example Request
$ curl http://demo.wp-api.org/wp-json/wp/v2/tags
Create a Tag Create a Tag
Arguments Arguments
description
|
HTML description of the term. |
name
|
HTML title for the term.
Required: 1 |
slug
|
An alphanumeric identifier for the term unique to its type. |
meta
|
Meta fields. |
Retrieve a Tag Retrieve a Tag
Arguments Arguments
id
|
Unique identifier for the term. |
context
|
Scope under which the request is made; determines fields present in response.
Default: One of: |
Definition Definition
GET /wp/v2/tags/<id>
Example Request Example Request
$ curl http://demo.wp-api.org/wp-json/wp/v2/tags/<id>
Update a Tag Update a Tag
Arguments Arguments
id
|
Unique identifier for the term. |
description
|
HTML description of the term. |
name
|
HTML title for the term. |
slug
|
An alphanumeric identifier for the term unique to its type. |
meta
|
Meta fields. |
Delete a Tag Delete a Tag
Arguments Arguments
id
|
Unique identifier for the term. |
force
|
Required to be true, as terms do not support trashing. |
Definition Definition
DELETE /wp/v2/tags/<id>
Example Request Example Request
$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/tags/<id>