Таксономії (taxonomies)

Ці маршрути дають змогу отримати таксономії.

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

/wp/v2/taxonomies // працює з усіма таксономіями
/wp/v2/taxonomies/{taxonomy} // працює із зазначеною замість {taxonomy} таксономією

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

Зміст:




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

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

ПараметрКонтекстОпис
capabilities
об’єкт		editУсі можливості, що використовуються таксономією.
Лише для читання.
description
рядок		view, editОпис таксономії.
Лише для читання.
hierarchical
логічний		view, editТаксономія є ієрархічною чи ні.
Лише для читання.
labels
об’єкт		editЗаголовки таксономії (різні назви).
Лише для читання.
name
рядок		view, edit, embedНазва таксономії.
Лише для читання.
slug
рядок		view, edit, embedЛітерно-цифровий ідентифікатор для таксономії.
Лише для читання.
show_cloud
логічний		editЧи повинна бути показана хмара елементів.
Лише для читання.
types
масив		view, editТипи пов’язані з таксономією.
Лише для читання.
rest_base
рядок		view, edit, embedБазовий шлях REST API для таксономії.
Лише для читання.

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

Запит OPTIONS до маршруту поверне повний опис цього маршруту: ендпоінти, їх параметри, схему.

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

GitHub

{
    "namespace": "wp/v2",
    "methods": [
        "GET"
    ],
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "args": {
                "context": {
                    "required": false,
                    "default": "view",
                    "enum": [
                        "view",
                        "embed",
                        "edit"
                    ],
                    "description": "Рамки, в яких зроблено запит, визначають поля відповіді.",
                    "type": "string"
                },
                "type": {
                    "required": false,
                    "description": "Обмежити вибірку таксономіями асоційованими з певним типом запису.",
                    "type": "string"
                }
            }
        }
    ],
    "Schema": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "taxonomy",
        "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
            },
            "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
            },
            "show_cloud": {
                "description": "Чи потрібно показувати хмару елементів.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "types": {
                "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://wp-test.ru/wp-json/wp/v2/taxonomies"
    }
}

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

GitHub

{
    "namespace": "wp/v2",
    "methods": [
        "GET"
    ],
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "args": {
                "taxonomy": {
                    "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": "taxonomy",
        "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
            },
            "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
            },
            "show_cloud": {
                "description": "Чи потрібно показувати хмару елементів.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "types": {
                "description": "Типи асоційовані з таксономією.",
                "type": "array",
                "items": {
                    "type": "string"
                },
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "rest_base": {
                "description": "базовий шлях REST для таксономії.",
                "type": "string",
                "context": [
                    "view",
                    "edit",
                    "embed"
                ],
                "readonly": true
            }
        }
    }
}




Список таксономій

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

Вид запиту

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

GET /wp/v2/taxonomies

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

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

Типово: view

type
Обмежити результати вибірки за таксономіями, пов’язаних із певним типом запису.

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

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

Результат запиту таксономій на щойно встановлений WordPress:

{
	"category": {
		"name": "Рубрики",
		"slug": "category",
		"description": "",
		"types": [
			"post"
		],
		"hierarchical": true,
		"rest_base": "categories",
		"_links": {
			"collection": [
				{
					"href": "http://wp-test.ru/wp-json/wp/v2/taxonomies"
				}
			],
			"wp:items": [
				{
					"href": "http://wp-test.ru/wp-json/wp/v2/categories"
				}
			],
			"curies": [
				{
					"name": "wp",
					"href": "https://api.w.org/{rel}",
					"templated": true
				}
			]
		}
	},
	"post_tag": {
		"name": "Мітки",
		"slug": "post_tag",
		"description": "",
		"types": [
			"post"
		],
		"hierarchical": false,
		"rest_base": "tags",
		"_links": {
			"collection": [
				{
					"href": "http://wp-test.ru/wp-json/wp/v2/taxonomies"
				}
			],
			"wp:items": [
				{
					"href": "http://wp-test.ru/wp-json/wp/v2/tags"
				}
			],
			"curies": [
				{
					"name": "wp",
					"href": "https://api.w.org/{rel}",
					"templated": true
				}
			]
		}
	}
}




Отримання таксономії

Алгоритм схожий на роботу функції get_taxonomy() , але набір даних, що повертаються обмежений схемою.

У відповідь можна додати будь-які дані про таксономію за допомогою фільтра rest_prepare_taxonomy .

Вид запиту

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

GET /wp/v2/taxonomies/{taxonomy}

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

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

Типово: view

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

$ curl http://demo.wp-api.org/wp-json/wp/v2/taxonomies/category
{
	"name": "Рубрики",
	"slug": "category",
	"description": "",
	"types": [
		"post"
	],
	"hierarchical": true,
	"rest_base": "categories",
	"_links": {
		"collection": [
			{
				"href": "http://example.com/wp-json/wp/v2/taxonomies"
			}
		],
		"wp:items": [
			{
				"href": "http://example.com/wp-json/wp/v2/categories"
			}
		],
		"curies": [
			{
				"name": "wp",
				"href": "https://api.w.org/{rel}",
				"templated": true
			}
		]
	}
}

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *