タグ

2020.03.30 2020.03.30

TOPICS

スキーマ

タグオブジェクトに定義されているフィールドの一覧です。

id
int型
タームのID
読み取り専用
Context: viewembededit
count
int型
対象のタームで公開されている投稿の数
読み取り専用
Context: viewedit
description
string型

タームのHTMLの説明
Context: viewedit
link
string型
url
タームのURL
読み取り専用
Context: viewembededit
name
string型
タームのHTMLタイトル
Context: viewembededit
slug
string型
タームのスラッグ
Context: viewembededit
taxonomy
string型
タームのタイプ
読み取り専用
Context: viewembededit
例:categorypost_tagnav_menulink_categorypost_format
meta
object
メタフィールド
Context: viewedit

リクエスト例

$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/tags

タグリスト

引数

contextリクエストが行われるスコープ。レスポンスに存在するフィールドを決定する。
デフォルト:view
例:viewembededit
page現在のページ数
デフォルト:1
per_page1ページの件数
デフォルト:10
search文字列にマッチする結果に絞り込む
exclude特定のIDのタグを除外する
include指定されたIDのタグに絞り込む
offset結果の何番目から取得するか
orderソート順を昇順か降順か決める
デフォルト:asc
例:ascdesc
orderbyソート順の基準を決める
デフォルト:name
例:idincludenamesluginclude_slugsterm_groupdescriptioncount
hide_empty投稿で使われていないタグを表示するかどうか
post特定の投稿のタグのみに絞り込む
slugタグをslugで絞り込む

定義

GET /wp/v2/tags

リクエスト例

$ curl https://example.com/wp-json/wp/v2/tags

タグの作成

descriptionタームのHTMLの説明
nameタームの名前
必須項目
slugタームのスラッグ
metaメタフィールド

定義

POST /wp/v2/tags

IDを指定してタグを取得

引数

idタームのID
contextリクエストが行われるスコープ。レスポンスに存在するフィールドを決定する。
デフォルト:view
例:viewembededit

定義

GET /wp/v2/tags/<id>

リクエスト例

$ curl https://example.com/wp-json/wp/v2/tags/<id>

タグの更新

引数

idタームID
descriptionタームの説明
nameタームのタイトル
slugタームのスラッグ
metaメタフィールド

定義

POST /wp/v2/tags/<id>

タグの削除

idタームのID
forceゴミ箱に入れず完全に削除するかどうか

定義

DELETE /wp/v2/tags/<id>

リクエスト例

$ curl -X DELETE https://example.com/wp-json/wp/v2/tags/<id>