Типи записів (types)

Ці маршрути дозволяють отримати дані всіх або зазначеного типу запису. Працює з даними типу запису, а не записами зазначеного типу!

Можливі маршрути (кінцеві точки маршрутів описані нижче):

/wp/v2/types // працює з усіма типами записів
/wp/v2/types/{post_type} // працює із зазначеним замість {post_type} типом запису

Клас контролера: WP_REST_Post_Types_Controller{}

Зміст:

Схема ресурсу

Схема показує всі поля, які є об’єкта: поля об’єкта які поверне запит.

Параметр	Контекст	Опис
capabilities об’єкт	`edit`	Усі можливості, які використовуються типом запису. Лише для читання.
description рядок	`view, edit`	Опис типу запису. Лише для читання.
hierarchical true/false	`view, edit`	Чи може цей тип запису бути батьківським? Лише для читання.
viewable true/false	`edit`	Чи може бути тип запису доступним для перегляду. Лише для читання.
labels об’єкт	`edit`	Теги типу запису для різних контекстів. Лише для читання.
name рядок	`view, edit, embed`	Назва типу запису. Лише для читання.
slug рядок	`view, edit, embed`	Ярлик тип запису. Лише для читання.
supports об’єкт	`edit`	Всі можливості, що підтримуються типом запису. Лише для читання.
taxonomies масив	`view, edit`	Таксономії асоційовані із типом запису. Лише для читання.
rest_base рядок	`view, edit, embed`	Базовий шлях REST типу запису. Лише для читання.

Опис маршруту

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

GitHub

{
    "namespace": "wp/v2",
    "methods": [
        "GET"
    ],
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "args": {
                "context": {
                    "required": false,
                    "default": "view",
                    "enum": [
                        "view",
                        "embed",
                        "edit"
                    ],
                    "description": "Рамки, в яких зроблено запит, визначають поля відповіді.",
                    "type": "string"
                }
            }
        }
    ],
    "Schema": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "type",
        "type": "object",
        "properties": {
            "capabilities": {
                "description": "Всі можливості, що використовуються типом запису.",
                "type": "object",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "description": {
                "description": "Человекочитаний опис типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "hierarchical": {
                "description": "Ці тип запису може бути батьківським.",
                "type": "boolean",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "viewable": {
                "description": "Чи може бути тип запису доступним для перегляду.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "labels": {
                "description": "Чоловекочитабельні мітки для типу запису для різних контекстів.",
                "type": "object",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "name": {
                "description": "Назва для типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit",
                    "embed"
                ],
                "readonly": true
            },
            "slug": {
                "description": "Буквенно-цифровий ідентифікатор типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit",
                    "embed"
                ],
                "readonly": true
            },
            "supports": {
                "description": "Всі можливості, що підтримуються типом запису.",
                "type": "object",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "taxonomies": {
                "description": "Таксономії асоційовані з типом запису.",
                "type": "array",
                "items": {
                    "type": "string"
                },
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "rest_base": {
                "description": "базовий шлях REST для типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit",
                    "embed"
                ],
                "readonly": true
            }
        }
    },
    "_links": {
        "self": "http://wptest.ru/wp-json/wp/v2/types"
    }
}

$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/types/{post_type}

GitHub

{
    "namespace": "wp/v2",
    "methods": [
        "GET"
    ],
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "args": {
                "type": {
                    "required": false,
                    "description": "Буквенно-цифровий ідентифікатор типу запису.",
                    "type": "string"
                },
                "context": {
                    "required": false,
                    "default": "view",
                    "enum": [
                        "view",
                        "embed",
                        "edit"
                    ],
                    "description": "Рамки, в яких зроблено запит, визначають поля відповіді.",
                    "type": "string"
                }
            }
        }
    ],
    "Schema": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "type",
        "type": "object",
        "properties": {
            "capabilities": {
                "description": "Всі можливості, що використовуються типом запису.",
                "type": "object",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "description": {
                "description": "Человекочитаний опис типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "hierarchical": {
                "description": "Ці тип запису може бути батьківським.",
                "type": "boolean",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "viewable": {
                "description": "Чи може бути тип запису доступним для перегляду.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "labels": {
                "description": "Чоловекочитабельні мітки для типу запису для різних контекстів.",
                "type": "object",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "name": {
                "description": "Назва для типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit",
                    "embed"
                ],
                "readonly": true
            },
            "slug": {
                "description": "Буквенно-цифровий ідентифікатор типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit",
                    "embed"
                ],
                "readonly": true
            },
            "supports": {
                "description": "Всі можливості, що підтримуються типом запису.",
                "type": "object",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "taxonomies": {
                "description": "Таксономії асоційовані з типом запису.",
                "type": "array",
                "items": {
                    "type": "string"
                },
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "rest_base": {
                "description": "базовий шлях REST для типу запису.",
                "type": "string",
                "context": [
                    "view",
                    "edit",
                    "embed"
                ],
                "readonly": true
            }
        }
    }
}

Список усіх типів записів

Алгоритм схожий на роботу функції get_post_types() .

Вид запиту

Доступ: публічний

GET /wp/v2/types

Параметри запиту

context (рядок)

Область, у якій виконується запит; визначає поля, присутні у відповіді.

Можливо:
view, embed, edit

За замовчуванням: view

Приклад запиту

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

Відповідь:

{
	"post": {
		"description": "",
		"hierarchical": false,
		"name": "Записи",
		"slug": "post",
		"taxonomies": [
			"категорії",
			"post_tag"
		],
		"rest_base": "posts",
		"_links": {
			"collection": [
				{
					"href": "http://example.com/wp-json/wp/v2/types"
				}
			],
			"wp:items": [
				{
					"href": "http://example.com/wp-json/wp/v2/posts"
				}
			],
			"curies": [
				{
					"name": "wp",
					"href": "https://api.w.org/{rel}",
					"templated": true
				}
			]
		}
	},
	"page": {
		"description": "",
		"hierarchical": true,
		"name": "Сторінки",
		"slug": "page",
		"таксономії": [],
		"rest_base": "pages",
		"_links": {
			"collection": [
				{
					"href": "http://example.com/wp-json/wp/v2/types"
				}
			],
			"wp:items": [
				{
					"href": "http://example.com/wp-json/wp/v2/pages"
				}
			],
			"curies": [
				{
					"name": "wp",
					"href": "https://api.w.org/{rel}",
					"templated": true
				}
			]
		}
	},
	"attachment": {
		"description": "",
		"hierarchical": false,
		"name": "Медіафайли",
		"slug": "attachment",
		"таксономії": [],
		"rest_base": "media",
		"_links": {
			"collection": [
				{
					"href": "http://example.com/wp-json/wp/v2/types"
				}
			],
			"wp:items": [
				{
					"href": "http://example.com/wp-json/wp/v2/media"
				}
			],
			"curies": [
				{
					"name": "wp",
					"href": "https://api.w.org/{rel}",
					"templated": true
				}
			]
		}
	}
}

Отримання зазначеного типу запису

Отримує дані вказаного типу запису.

Вид запиту

Доступ: публічний

GET /wp/v2/types/{post_type}

Параметри запиту

type (рядок) (обов’язковий)

Назва типу запису, дані якого потрібно отримати.

context (рядок)

Область, у якій виконується запит; визначає поля, присутні у відповіді.

Можливо:
view, embed, edit

За замовчуванням: view

Приклад запиту

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

Відповідь:

{
	"description": "",
	"hierarchical": false,
	"name": "Записи",
	"slug": "post",
	"taxonomies": [
		"категорії",
		"post_tag"
	],
	"rest_base": "posts",
	"_links": {
		"collection": [
			{
				"href": "http://example.com/wp-json/wp/v2/types"
			}
		],
		"wp:items": [
			{
				"href": "http://example.com/wp-json/wp/v2/posts"
			}
		],
		"curies": [
			{
				"name": "wp",
				"href": "https://api.w.org/{rel}",
				"templated": true
			}
		]
	}
}

Типи записів (types)

Схема ресурсу

Опис маршруту

Список усіх типів записів

Вид запиту

Параметри запиту

Приклад запиту

Отримання зазначеного типу запису

Вид запиту

Параметри запиту

Приклад запиту

Залишити відповідь Скасувати коментар