タグ
2020.03.30
2020.03.30
TOPICS
スキーマ
タグオブジェクトに定義されているフィールドの一覧です。
| id int型 | タームのID 読み取り専用 Context: view, embed, edit |
| count int型 | 対象のタームで公開されている投稿の数 読み取り専用 Context: view, edit |
| description string型 | タームのHTMLの説明 Context: view, edit |
| link string型 url | タームのURL 読み取り専用 Context: view, embed, edit |
| name string型 | タームのHTMLタイトル Context: view, embed, edit |
| slug string型 | タームのスラッグ Context: view, embed, edit |
| taxonomy string型 | タームのタイプ 読み取り専用 Context: view, embed, edit例： category, post_tag, nav_menu, link_category, post_format |
| meta object | メタフィールド Context: view, edit |
リクエスト例
$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/tagsタグリスト
引数
| context | リクエストが行われるスコープ。レスポンスに存在するフィールドを決定する。 デフォルト：view 例： view, embed, edit |
| page | 現在のページ数 デフォルト：1 |
| per_page | 1ページの件数 デフォルト：10 |
| search | 文字列にマッチする結果に絞り込む |
| exclude | 特定のIDのタグを除外する |
| include | 指定されたIDのタグに絞り込む |
| offset | 結果の何番目から取得するか |
| order | ソート順を昇順か降順か決める デフォルト：asc 例： asc, desc |
| orderby | ソート順の基準を決める デフォルト：name 例： id, include, name, slug, include_slugs, term_group, description, count |
| 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 例： view, embed, edit |
定義
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>