Ці маршрути дозволяють отримати/створити/оновити/видалити вкладення (медіа).
Можливі маршрути (кінцеві точки маршрутів описані нижче):
/wp/v2/media // працює з усіма вкладеннями
/wp/v2/media/{ID} // працює із зазначеною замість {ID} вкладенням
/wp/v2/media/{ID}/post-process
/wp/v2/media/{ID}/edit Клас контролера: WP_REST_Posts_Controller{} .
Схема показує всі поля, які існують для запису об’єкта: поля об’єкта які поверне запит.
Параметр Контекст Опис date Рядок/null view, edit, embed Дата публікації об’єкта, по часовій зоні сайту. date_gmt Рядок/null view, edit Час публікації об’єкта, за GMT. guid Об’єкт readonly view, edit Глобальний унікальний ідентифікатор об’єкта. id Число readonly view, edit, embed Унікальний ідентифікатор об’єкта. link Рядок readonly view, edit, embed URL об’єкта. modified Рядок readonly view, edit Дата останньої зміни об’єкта за тимчасовою зоною сайту. modified_gmt Рядок readonly view, edit Дата останньої зміни об’єкта в GMT. slug Рядок view, edit, embed Літерно-цифровий ідентифікатор для об’єкта є унікальним для його типу. status Рядок view, edit Іменований статус для об’єкта. type Рядок readonly view, edit, embed Тип запису об’єкта. permalink_template Рядок readonly edit Постійні посилання шаблон для об’єкта. generated_slug Рядок readonly edit Ярлик автоматично створено із заголовка об’єкта. title Об’єкт view, edit, embed Назва об’єкта. author Число view, edit, embed ID автора об’єкта. comment_status Рядок view, edit Чи відкриті коментарі для об’єкта. ping_status Рядок view, edit Чи приймає об’єкт сповіщення. meta Об’єкт view, edit Мета поля. template Рядок view, edit Файл теми, який використовується для показу об’єкта. alt_text Рядок view, edit, embed Альтернативний текст для показу, коли вкладення не відображається. caption Об’єкт view, edit, embed Підпис вкладення. description Об’єкт view, edit Опис вкладення. media_type Рядок readonly view, edit, embed Тип вкладення. mime_type Рядок readonly view, edit, embed MIME тип вкладення. media_details Об’єкт readonly view, edit, embed Подробиці про медіа файл, специфічні його типу. post Число view, edit ID для асоційованих записів вкладення. source_url Рядок readonly view, edit, embed URL оригіналу файлу вкладення. missing_image_sizes Масив readonly edit Список відсутніх розмірів зображення для вкладення.
Запит OPTIONS до маршруту поверне повний опис цього маршруту: ендпоінти, їх параметри, схему.
$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/media GitHub
{
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"embed",
"edit"
],
"description": "Рамки, в яких зроблено запит, визначають поля відповіді.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Поточна сторінка колекції.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Максимальна кількість об'єктів, що повертається у вибірці.",
"type": "integer"
},
"search": {
"required": false,
"description": "Обмежити результати до відповідних рядків.",
"type": "string"
},
"after": {
"required": false,
"description": "Обмежити відповідь записами опублікованими після заданої ISO8601 сумісної дати.",
"type": "string"
},
"author": {
"required": false,
"default": [],
"description": "Обмежити вибірку записами певних авторів.",
"type": "array",
"items": {
"type": "integer"
}
},
"author_exclude": {
"required": false,
"default": [],
"description": "Переконатися, що вибірка виключає записи призначені певним авторам.",
"type": "array",
"items": {
"type": "integer"
}
},
"before": {
"required": false,
"description": "Обмежити відповідь записами, опублікованими до заданої ISO8601 сумісної дати.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Переконатися, що вибірка виключає певні ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Обмежити вибірку до певних ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Зсув вибірки на певну кількість об'єктів.",
"type": "integer"
},
"Order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Упорядкувати сортування атрибуту за зростанням або зменшенням.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title"
],
"description": "Сортувати колекцію за атрибутом об'єкта.",
"type": "string"
},
"parent": {
"required": false,
"default": [],
"description": "Обмежити вибірку до певних ID батьків.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_exclude": {
"required": false,
"default": [],
"description": "Обмежити вибірку до об'єктів за винятком тих, хто має певний ID батька.",
"type": "array",
"items": {
"type": "integer"
}
},
"slug": {
"required": false,
"description": "Обмежити вибірку до записів з одним або декількома встановленими конкретними ярликами.",
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"required": false,
"default": "inherit",
"description": "Обмежити вибірку до записів з одним або декількома встановленими статусами.",
"type": "array",
"items": {
"enum": [
"inherit",
"private",
"trash"
],
"type": "string"
}
},
"media_type": {
"required": false,
"enum": [
"image",
"video",
"text",
"application",
"audio"
],
"description": "Обмежити вибірку до вкладень певного типу медіа.",
"type": "string"
},
"mime_type": {
"required": false,
"description": "Обмежити вибірку до вкладень певного типу MIME.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"date": {
"required": false,
"description": "Дата публікації об'єкта за тимчасовою зоною сайту.",
"type": "string"
},
"date_gmt": {
"required": false,
"description": "Час публікації об'єкта, за GMT.",
"type": "string"
},
"slug": {
"required": false,
"description": "Буквенно-цифровий ідентифікатор для об'єкта унікальний для його типу.",
"type": "string"
},
"status": {
"required": false,
"enum": [
"Publish",
"Future",
"draft",
"pending",
"private"
],
"description": "Іменований статус для об'єкта.",
"type": "string"
},
"title": {
"required": false,
"description": "Назва для об'єкта.",
"type": "object"
},
"author": {
"required": false,
"description": "ID автора об'єкта.",
"type": "integer"
},
"comment_status": {
"required": false,
"enum": [
"open",
"closed"
],
"description": "Чи відкриті коментарі для об'єкта.",
"type": "string"
},
"ping_status": {
"required": false,
"enum": [
"open",
"closed"
],
"description": "Чи приймає об'єкт сповіщення.",
"type": "string"
},
"meta": {
"required": false,
"description": "Мета поля.",
"type": "object"
},
"template": {
"required": false,
"description": "Файл теми, який використовується для показу об'єкта.",
"type": "string"
},
"alt_text": {
"required": false,
"description": "Альтернативний текст для показу, коли вкладення не відображається.",
"type": "string"
},
"caption": {
"required": false,
"description": "Підпис вкладення.",
"type": "object"
},
"description": {
"required": false,
"description": "Опис вкладення.",
"type": "object"
},
"post": {
"required": false,
"description": "ID для асоційованих записів для вкладення.",
"type": "integer"
}
}
}
],
"Schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "attachment",
"type": "object",
"properties": {
"date": {
"description": "Дата публікації об'єкта за тимчасовою зоною сайту.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit",
"embed"
]
},
"date_gmt": {
"description": "Час публікації об'єкта, за GMT.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit"
]
},
"guid": {
"description": "Глобальний унікальний ідентифікатор об'єкта.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"raw": {
"description": "GUID для об'єкта, як він існує в базі даних.",
"type": "string",
"context": [
"edit"
],
"readonly": true
},
"rendered": {
"description": "GUID для об'єкта, перетворений для показу.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"id": {
"description": "Унікальний ідентифікатор об'єкта.",
"type": "integer",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"link": {
"description": "URL об'єкта.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"modified": {
"description": "Дата останньої зміни об'єкта за тимчасовою зоною сайту.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"modified_gmt": {
"description": "Дата останньої зміни об'єкта в GMT.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Буквенно-цифровий ідентифікатор для об'єкта унікальний для його типу.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"status": {
"description": "Іменований статус для об'єкта.",
"type": "string",
"enum": [
"Publish",
"Future",
"draft",
"pending",
"private"
],
"context": [
"view",
"edit"
]
},
"type": {
"description": "Тип запису для об'єкта.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"title": {
"description": "Назва для об'єкта.",
"type": "object",
"context": [
"view",
"edit",
"embed"
],
"properties": {
"raw": {
"description": "Назва об'єкта як вона існує в базі даних.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML назва об'єкта, перетворена для показу.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
}
},
"author": {
"description": "ID автора об'єкта.",
"type": "integer",
"context": [
"view",
"edit",
"embed"
]
},
"comment_status": {
"description": "Чи відкриті коментарі для об'єкта.",
"type": "string",
"enum": [
"open",
"closed"
],
"context": [
"view",
"edit"
]
},
"ping_status": {
"description": "Чи приймає об'єкт сповіщення.",
"type": "string",
"enum": [
"open",
"closed"
],
"context": [
"view",
"edit"
]
},
"meta": {
"description": "Мета поля.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": []
},
"template": {
"description": "Файл теми, який використовується для показу об'єкта.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt_text": {
"description": "Альтернативний текст для показу, коли вкладення не відображається.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"caption": {
"description": "Підпис вкладення.",
"type": "object",
"context": [
"view",
"edit",
"embed"
],
"properties": {
"raw": {
"description": "Підпис для вкладення, як він існує в базі даних.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML підпис для вкладення, перетворений для показу.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
}
},
"description": {
"description": "Опис вкладення.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"raw": {
"description": "Опис для об'єкта як він існує в базі даних.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML опис для об'єкта перетворений для показу.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"media_type": {
"description": "Тип вкладення.",
"type": "string",
"enum": [
"image",
"file"
],
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"mime_type": {
"description": "MIME тип вкладення.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"media_details": {
"description": "Подробиці про медіа файл, специфічні його типу.",
"type": "object",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"post": {
"description": "ID для асоційованих записів для вкладення.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"source_url": {
"description": "URL оригіналу файлу вкладення.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"links": [
{
"rel": "https://api.w.org/action-assign-author",
"title": "Поточний користувач може змінити автора для цього запису.",
"href": "http://wp-test.ru/wp-json/wp/v2/media/{id}",
"targetSchema": {
"type": "object",
"properties": {
"author": {
"type": "integer"
}
}
}
}
]
},
"_links": {
"self": "http://wp-test.ru/wp-json/wp/v2/media"
}
}
Алгоритм схожий з роботою функції get_posts() , де кожного об’єкта вкладення додані специфічні властивості.
Вид запиту Доступ: публічний
GET /wp/v2/media Параметри запиту
context
Область, у якій виконується запит; визначає поля, присутні у відповіді. Можливоview ,embed ,edit .Типово: view
page
Поточна сторінка колекції.За замовчуванням: 1
per_page
Максимальна кількість вкладень у результуючому наборі.Типово: 10
search
Обмеження за кількістю записів, що повертаються при пошуку.
after
Обмежити відповідь до вкладень, опублікованих після заданої дати, що відповідає ISO8601.
before
Обмежити відповідь до вкладень, опублікованих до заданої дати, що відповідає ISO8601.
exclude
Виключає з набору вкладення їх ID.
include
Включає до набору вкладення їх ID. У наборі будуть лише ті вкладення, ID яких були вказані.
offset
Усунення (відступ) набору результатів на вказане число.За замовчуванням: 1
order
Сортування вкладень у вибірці. Може бутиasc абоdesc .За замовчуванням: desc
orderby
Сортування записів у вибірці за атрибутами. Можливоauthor ,date ,id ,include ,modified ,parent ,relevance ,slug ,title .Типово: date
parent
Обмежити вибірку до певних ID батьків.
parent_exclude
Обмежити вибірку до об’єктів за винятком тих, хто має певний ID батька.
slug
Обмеження вибірки за вказаним одним ярликом вкладення або кількома.
status
Обмеження вибірки за одним статусом чи декільком.За замовчуванням: inherit
media_type
Обмежити вибірку до вкладень певного типу медіа. Можливо:image ,video ,audio ,application
mime_type
Обмежити вибірку до вкладень певного типу MIME. Приклад запиту $ curl http://demo.wp-api.org/wp-json/wp/v2/media Повернеться масив об’єктів, де кожен об’єкт вкладення схожий на те, що описаний у пункті “Отримати вкладення”:
[
{
... дані вкладення <id> ...
},
{
... дані вкладення <id> ...
},
{
... дані вкладення <id> ...
}
]
Створює файл медіа. Алгоритм схожий роботу функції wp_insert_attachment() .
Вид запиту Доступ: потрібна авторизація
POST /wp/v2/media Параметри запиту
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 для асоційованих записів вкладення. Приклад запиту $ curl -X POST http://demo.wp-api.org/wp-json/wp/v2/media Запит OPTIONS до маршруту поверне повний опис цього маршруту: ендпоінти, їх параметри, схему.
$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/media/{id} GitHub
{
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Унікальний ідентифікатор об'єкта.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"embed",
"edit"
],
"description": "Рамки, в яких зроблено запит, визначають поля відповіді.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Унікальний ідентифікатор об'єкта.",
"type": "integer"
},
"date": {
"required": false,
"description": "Дата публікації об'єкта за тимчасовою зоною сайту.",
"type": "string"
},
"date_gmt": {
"required": false,
"description": "Час публікації об'єкта, за GMT.",
"type": "string"
},
"slug": {
"required": false,
"description": "Буквенно-цифровий ідентифікатор для об'єкта унікальний для його типу.",
"type": "string"
},
"status": {
"required": false,
"enum": [
"Publish",
"Future",
"draft",
"pending",
"private"
],
"description": "Іменований статус для об'єкта.",
"type": "string"
},
"title": {
"required": false,
"description": "Назва для об'єкта.",
"type": "object"
},
"author": {
"required": false,
"description": "ID автора об'єкта.",
"type": "integer"
},
"comment_status": {
"required": false,
"enum": [
"open",
"closed"
],
"description": "Чи відкриті коментарі для об'єкта.",
"type": "string"
},
"ping_status": {
"required": false,
"enum": [
"open",
"closed"
],
"description": "Чи приймає об'єкт сповіщення.",
"type": "string"
},
"meta": {
"required": false,
"description": "Мета поля.",
"type": "object"
},
"template": {
"required": false,
"description": "Файл теми, який використовується для показу об'єкта.",
"type": "string"
},
"alt_text": {
"required": false,
"description": "Альтернативний текст для показу, коли вкладення не відображається.",
"type": "string"
},
"caption": {
"required": false,
"description": "Підпис вкладення.",
"type": "object"
},
"description": {
"required": false,
"description": "Опис вкладення.",
"type": "object"
},
"post": {
"required": false,
"description": "ID для асоційованих записів для вкладення.",
"type": "integer"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Унікальний ідентифікатор об'єкта.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Чи ігнорувати переміщення в кошик і примусово видаляти.",
"type": "boolean"
}
}
}
],
"Schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "attachment",
"type": "object",
"properties": {
"date": {
"description": "Дата публікації об'єкта за тимчасовою зоною сайту.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit",
"embed"
]
},
"date_gmt": {
"description": "Час публікації об'єкта, за GMT.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit"
]
},
"guid": {
"description": "Глобальний унікальний ідентифікатор об'єкта.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"raw": {
"description": "GUID для об'єкта, як він існує в базі даних.",
"type": "string",
"context": [
"edit"
],
"readonly": true
},
"rendered": {
"description": "GUID для об'єкта, перетворений для показу.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"id": {
"description": "Унікальний ідентифікатор об'єкта.",
"type": "integer",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"link": {
"description": "URL об'єкта.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"modified": {
"description": "Дата останньої зміни об'єкта за тимчасовою зоною сайту.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"modified_gmt": {
"description": "Дата останньої зміни об'єкта в GMT.",
"type": "string",
"format": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Буквенно-цифровий ідентифікатор для об'єкта унікальний для його типу.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"status": {
"description": "Іменований статус для об'єкта.",
"type": "string",
"enum": [
"Publish",
"Future",
"draft",
"pending",
"private"
],
"context": [
"view",
"edit"
]
},
"type": {
"description": "Тип запису для об'єкта.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"title": {
"description": "Назва для об'єкта.",
"type": "object",
"context": [
"view",
"edit",
"embed"
],
"properties": {
"raw": {
"description": "Назва об'єкта як вона існує в базі даних.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML назва об'єкта, перетворена для показу.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
}
},
"author": {
"description": "ID автора об'єкта.",
"type": "integer",
"context": [
"view",
"edit",
"embed"
]
},
"comment_status": {
"description": "Чи відкриті коментарі для об'єкта.",
"type": "string",
"enum": [
"open",
"closed"
],
"context": [
"view",
"edit"
]
},
"ping_status": {
"description": "Чи приймає об'єкт сповіщення.",
"type": "string",
"enum": [
"open",
"closed"
],
"context": [
"view",
"edit"
]
},
"meta": {
"description": "Мета поля.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": []
},
"template": {
"description": "Файл теми, який використовується для показу об'єкта.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt_text": {
"description": "Альтернативний текст для показу, коли вкладення не відображається.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"caption": {
"description": "Підпис вкладення.",
"type": "object",
"context": [
"view",
"edit",
"embed"
],
"properties": {
"raw": {
"description": "Підпис для вкладення, як він існує в базі даних.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML підпис для вкладення, перетворений для показу.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
}
},
"description": {
"description": "Опис вкладення.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"raw": {
"description": "Опис для об'єкта як він існує в базі даних.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML опис для об'єкта перетворений для показу.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"media_type": {
"description": "Тип вкладення.",
"type": "string",
"enum": [
"image",
"file"
],
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"mime_type": {
"description": "MIME тип вкладення.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"media_details": {
"description": "Подробиці про медіа файл, специфічні його типу.",
"type": "object",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"post": {
"description": "ID для асоційованих записів для вкладення.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"source_url": {
"description": "URL оригіналу файлу вкладення.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"links": [
{
"rel": "https://api.w.org/action-assign-author",
"title": "Поточний користувач може змінити автора для цього запису.",
"href": "http://wp-test.ru/wp-json/wp/v2/media/{id}",
"targetSchema": {
"type": "object",
"properties": {
"author": {
"type": "integer"
}
}
}
}
]
}
}
Вид запиту Доступ: публічний
GET /wp/v2/media/{id} Параметри запиту
id(обов’язковий)
Унікальний ідентифікатор вкладення. Цей же параметр вказується у маршруті.
context
Область, у якій виконується запит; визначає поля, присутні у відповіді. Можливоview ,embed ,edit .Типово: view
Приклад запиту Запросимо вкладення з ID = 411 :
$ curl http://demo.wp-api.org/wp-json/wp/v2/media/411 Результат:
{
"id": 411,
"date": "2018-06-10T17:41:48",
"date_gmt": "2018-06-10T14:41:48",
"guid": {
"rendered": "http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg"
},
"modified": "2018-06-10T17:41:48",
"modified_gmt": "2018-06-10T14:41:48",
"slug": "cropped-jellyfish-jpg",
"status": "inherit",
"type": "attachment",
"link": "http://wp-test.ru/cropped-jellyfish-jpg/",
"title": {
"rendered": "cropped-Jellyfish.jpg"
},
"author": 1,
"comment_status": "open",
"ping_status": "closed",
"template": "",
"meta": [],
"description": {
"rendered": "<p class="attachment"><a href='http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg'><img width ="250" height="250" src="http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg" class="attachment- medium size-medium" alt=" srcset="http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg 250w, http://wp-test .ru/wp-content/uploads/2018/03/cropped-Jellyfish-100x100.jpg 100w, http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish-150x150.jpg 150w " sizes="100vw" /></a></p>n<p>http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg< /p>n"
},
"caption": {
"rendered": "<p>http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg</p>n"
},
"alt_text": "",
"media_type": "image",
"mime_type": "image/jpeg",
"media_details": {
"width": 250,
"height": 250,
"file": "2018/03/cropped-Jellyfish.jpg",
"sizes": {
"woocommerce_gallery_thumbnail": {
"file": "cropped-Jellyfish-100x100.jpg",
"width": 100,
"height": 100,
"mime_type": "image/jpeg",
"source_url": "http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish-100x100.jpg"
},
"thumbnail": {
"file": "cropped-Jellyfish-150x150.jpg",
"width": 150,
"height": 150,
"mime_type": "image/jpeg",
"source_url": "http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish-150x150.jpg"
},
"twentyseventeen-thumbnail-avatar": {
"file": "cropped-Jellyfish-100x100.jpg",
"width": 100,
"height": 100,
"mime_type": "image/jpeg",
"source_url": "http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish-100x100.jpg"
},
"full": {
"file": "cropped-Jellyfish.jpg",
"width": 250,
"height": 250,
"mime_type": "image/jpeg",
"source_url": "http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg"
}
},
"image_meta": {
"aperture": "0",
"credit": "",
"camera": "",
"caption": "",
"created_timestamp": "0",
"copyright": "",
"focal_length": "0",
"iso": "0",
"shutter_speed": "0",
"title": "",
"orientation": "0",
"keywords": []
}
},
"post": null,
"source_url": "http://wp-test.ru/wp-content/uploads/2018/03/cropped-Jellyfish.jpg",
"_links": {
"self": [
{
"attributes": [],
"href": "http://wp-test.ru/wp-json/wp/v2/media/411"
}
],
"collection": [
{
"attributes": [],
"href": "http://wp-test.ru/wp-json/wp/v2/media"
}
],
"about": [
{
"attributes": [],
"href": "http://wp-test.ru/wp-json/wp/v2/types/attachment"
}
],
"author": [
{
"attributes": {
"embeddable": true
},
"href": "http://wp-test.ru/wp-json/wp/v2/users/1"
}
],
"replies": [
{
"attributes": {
"embeddable": true
},
"href": "http://wp-test.ru/wp-json/wp/v2/comments?post=411"
}
]
}
}
Алгоритм схожий роботу функції wp_update_post()
Вид запиту Доступ: потрібна авторизація
POST|PUT|PATCH /wp/v2/media/{id} Параметри запиту Дивіться настройки під час створення вкладення .
Приклад запиту $ curl -X POST http://demo.wp-api.org/wp-json/wp/v2/media/25?caption=Новий підпис
Алгоритм схожий роботу функції wp_delete_attachment() .
Вид запиту Доступ: потрібна авторизація
DELETE /wp/v2/media/{id} Параметри запиту
force(true/false)
Чи ігнорувати переміщення в кошик і примусово видаляти.Типово: false
Приклад запиту Видалимо вкладення 25:
$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/media/25
Подальша обробка вкладення.
Вид запиту Доступ: потрібна авторизація.
POST /wp/v2/media/{ID}/post-process Параметри запиту
$action(рядок) (обов’язковий)
Яку обробку потрібно зробити. Можливі значення:create-image-subsizes. Редагування.
Вид запиту Доступ: потрібна авторизація.
POST /wp/v2/media/{ID}/edit Параметри запиту
$src(рядок) (обов’язковий)
URL-адресованого файлу зображення.
$rotation(число)
Величина (в градусах, від 0 до 360) для повороту зображення за годинниковою стрілкою.
$x(число)
У відсотках зображення, позиція X для початку обрізки. Можливі значення: 0 – 100.
$y(число)
У відсотках зображення, позиція Y для початку обрізки. Можливі значення: 0 – 100.
$width(число)
У відсотках зображення, ширина для обрізки зображення.
$height(число)
У відсотках зображення, висота для обрізки зображення. 