Schema

The schema defines all the fields that exist for a tag object.

id
integer

Unique identifier for the term.

Read only

Context: view, embed, edit

count
integer

Number of published posts for the term.

Read only

Context: view, edit

description
string

HTML description of the term.

Context: view, edit

name
string

HTML title for the term.

Context: view, embed, edit

slug
string

An alphanumeric identifier for the term unique to its type.

Context: view, embed, edit

taxonomy
string

Type attribution for the term.

Read only

Context: view, embed, edit

One of: category, post_tag, nav_menu, link_category, post_format

meta
object

Meta fields.

Context: view, edit

Example Request

$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/tags

List Tags

Arguments

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page

Current page of the collection.

Default: 1

per_page

Maximum number of items to be returned in result set.

Default: 10

search

Limit results to those matching a string.

exclude

Ensure result set excludes specific IDs.

Default:

include

Limit result set to specific IDs.

Default:

offset

Offset the result set by a specific number of items.

order

Order sort attribute ascending or descending.

Default: asc

One of: asc, desc

orderby

Sort collection by term attribute.

Default: name

One of: id, include, name, slug, term_group, description, count

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 a specific slug.

Definition

GET /wp/v2/tags

Example Request

$ curl http://demo.wp-api.org/wp-json/wp/v2/tags

Retrieve a Tag

Arguments

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

Definition

GET /wp/v2/tags/<id>

Example Request

$ curl http://demo.wp-api.org/wp-json/wp/v2/tags/<id>

Create a Tag

Arguments

description

HTML description of the term.

name

HTML title for the term.

Required: true

slug

An alphanumeric identifier for the term unique to its type.

meta

Meta fields.

Definition

POST /wp/v2/tags

Update a Tag

Arguments

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.

Definition

POST /wp/v2/tags/<id>

Example Request

Delete a Tag

Arguments

force

Required to be true, as terms do not support trashing.

Definition

DELETE /wp/v2/tags/<id>

Example Request

$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/tags/<id>