スキーマ

スキーマは、メディアアイテムレコード内に存在するすべてのフィールドを定義します。これらのエンドポイントからの応答には、_filterクエリパラメータが使用されているか、スキーマフィールドが特定のコンテキストにのみ表示されていない限り、以下のフィールドが含まれることが期待されます。

date 投稿が公開された日付、サイトのタイムゾーンで。
JSONデータ型: 文字列またはnull,
フォーマット: 日時 ( 詳細)

コンテキスト: view, edit, embed
date_gmt 投稿が公開された日付、GMTとして。
JSONデータ型: 文字列またはnull,
フォーマット: 日時 ( 詳細)

コンテキスト: view, edit
guid 投稿のグローバル一意識別子。
JSONデータ型: オブジェクト
読み取り専用
コンテキスト: view, edit
id 投稿の一意識別子。
JSONデータ型: 整数
読み取り専用
コンテキスト: view, edit, embed
link 投稿のURL。
JSONデータ型: 文字列,
フォーマット: uri

読み取り専用
コンテキスト: view, edit, embed
modified 投稿が最後に修正された日付、サイトのタイムゾーンで。
JSONデータ型: 文字列,
フォーマット: 日時 ( 詳細)

読み取り専用
コンテキスト: view, edit
modified_gmt 投稿が最後に修正された日付、GMTとして。
JSONデータ型: 文字列,
フォーマット: 日時 ( 詳細)

読み取り専用
コンテキスト: view, edit
slug 投稿のタイプに固有の英数字識別子。
JSONデータ型: 文字列
コンテキスト: view, edit, embed
status 投稿の名前付きステータス。
JSONデータ型: 文字列
コンテキスト: view, edit
一つの: publish, future, draft, pending, private
type 投稿のタイプ。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
permalink_template 投稿のパーマリンクテンプレート。
JSONデータ型: 文字列
読み取り専用
コンテキスト: edit
generated_slug 投稿タイトルから自動生成されたスラッグ。
JSONデータ型: 文字列
読み取り専用
コンテキスト: edit
title 投稿のタイトル。
JSONデータ型: オブジェクト
コンテキスト: view, edit, embed
author 投稿の著者のID。
JSONデータ型: 整数
コンテキスト: view, edit, embed
comment_status 投稿にコメントが開いているかどうか。
JSONデータ型: 文字列
コンテキスト: view, edit
一つの: open, closed
ping_status 投稿がピング可能かどうか。
JSONデータ型: 文字列
コンテキスト: view, edit
一つの: open, closed
meta メタフィールド。
JSONデータ型: オブジェクト
コンテキスト: view, edit
template 投稿を表示するために使用するテーマファイル。
JSONデータ型: 文字列
コンテキスト: view, edit
alt_text 添付ファイルが表示されないときに表示される代替テキスト。
JSONデータ型: 文字列
コンテキスト: view, edit, embed
caption 添付ファイルのキャプション。
JSONデータ型: オブジェクト
コンテキスト: view, edit, embed
description 添付ファイルの説明。
JSONデータ型: オブジェクト
コンテキスト: view, edit
media_type 添付ファイルのタイプ。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
一つの: image, file
mime_type 添付ファイルのMIMEタイプ。
JSONデータ型: 文字列
読み取り専用
コンテキスト: view, edit, embed
media_details メディアファイルに関する詳細、タイプに特有の。
JSONデータ型: オブジェクト
読み取り専用
コンテキスト: view, edit, embed
post 添付ファイルの関連投稿のID。
JSONデータ型: 整数
コンテキスト: view, edit
source_url 元の添付ファイルのURL。
JSONデータ型: 文字列,
フォーマット: uri

読み取り専用
コンテキスト: view, edit, embed
missing_image_sizes 添付ファイルの欠落している画像サイズのリスト。
JSONデータ型: 配列
読み取り専用
コンテキスト: edit

メディアのリスト

このエンドポイントをクエリして、メディアのコレクションを取得します。受け取る応答は、以下のURLクエリパラメータを使用して制御およびフィルタリングできます。

定義

GET /wp/v2/media

例リクエスト

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

引数
context リクエストが行われるスコープ; 応答に存在するフィールドを決定します。
デフォルト: view

一つの: view, embed, edit
page コレクションの現在のページ。
デフォルト: 1
per_page 結果セットに返される最大アイテム数。
デフォルト: 10
search 文字列に一致する結果に制限します。
after 指定されたISO8601準拠の日付以降に公開された投稿に制限します。
modified_after 指定されたISO8601準拠の日付以降に修正された投稿に制限します。
author 特定の著者に割り当てられた投稿に結果セットを制限します。
author_exclude 特定の著者に割り当てられた投稿を除外するように結果セットを確保します。
before 指定されたISO8601準拠の日付以前に公開された投稿に制限します。
modified_before 指定されたISO8601準拠の日付以前に修正された投稿に制限します。
exclude 特定のIDを除外するように結果セットを確保します。
include 特定のIDに結果セットを制限します。
offset 特定のアイテム数で結果セットをオフセットします。
order ソート属性を昇順または降順にします。
デフォルト: desc

一つの: asc, desc
orderby 投稿属性でコレクションをソートします。
デフォルト: date

一つの: author, date, id, include, modified, parent, relevance, slug, include_slugs, title
parent 特定の親IDを持つアイテムに結果セットを制限します。
parent_exclude 特定の親IDを持つアイテムを除外するように結果セットを制限します。
search_columns 検索される列名の配列。
slug 一つ以上の特定のスラッグを持つ投稿に結果セットを制限します。
status 一つ以上のステータスに割り当てられた投稿に結果セットを制限します。
デフォルト: inherit
media_type 特定のメディアタイプの添付ファイルに結果セットを制限します。
一つの: image, video, text, application, audio
mime_type 特定のMIMEタイプの添付ファイルに結果セットを制限します。

メディアアイテムの作成

引数
date 投稿が公開された日付、サイトのタイムゾーンで。
date_gmt 投稿が公開された日付、GMTとして。
slug 投稿のタイプに固有の英数字識別子。
status 投稿の名前付きステータス。
一つの: publish, future, draft, pending, private
title 投稿のタイトル。
author 投稿の著者のID。
comment_status 投稿にコメントが開いているかどうか。
一つの: open, closed
ping_status 投稿がピング可能かどうか。
一つの: open, closed
meta メタフィールド。
template 投稿を表示するために使用するテーマファイル。
alt_text 添付ファイルが表示されないときに表示される代替テキスト。
caption 添付ファイルのキャプション。
description 添付ファイルの説明。
post 添付ファイルの関連投稿のID。

定義

POST /wp/v2/media

メディアアイテムの取得

定義と例リクエスト

GET /wp/v2/media/<id>

このエンドポイントをクエリして、特定のメディアアイテムレコードを取得します。

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

引数
id 投稿の一意識別子。
context リクエストが行われるスコープ; 応答に存在するフィールドを決定します。
デフォルト: view

一つの: view, embed, edit

メディアアイテムの更新

引数
id 投稿の一意識別子。
date 投稿が公開された日付、サイトのタイムゾーンで。
date_gmt 投稿が公開された日付、GMTとして。
slug 投稿のタイプに固有の英数字識別子。
status 投稿の名前付きステータス。
一つの: publish, future, draft, pending, private
title 投稿のタイトル。
author 投稿の著者のID。
comment_status 投稿にコメントが開いているかどうか。
一つの: open, closed
ping_status 投稿がピング可能かどうか。
一つの: open, closed
meta メタフィールド。
template 投稿を表示するために使用するテーマファイル。
alt_text 添付ファイルが表示されないときに表示される代替テキスト。
caption 添付ファイルのキャプション。
description 添付ファイルの説明。
post 添付ファイルの関連投稿のID。

定義

POST /wp/v2/media/<id>

例リクエスト

メディアアイテムの削除

引数
id 投稿の一意識別子。
force ゴミ箱をバイパスして強制的に削除するかどうか。

定義

DELETE /wp/v2/media/<id>

例リクエスト

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