Статуси записів (statuses)

Ці маршрути дозволяють отримати статус постів.

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

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

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

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

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

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

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

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

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": "status",
        "type": "object",
        "properties": {
            "name": {
                "description": "Назва статусу.",
                "type": "string",
                "context": [
                    "embed",
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "private": {
                "description": "Чи мають записи з цим статусом бути особистими.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "protected": {
                "description": "Чи мають бути захищені записи з цим статусом.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "public": {
                "description": "Чи показувати записи з цим статусом на частині сайту для відвідувачів.",
                "type": "boolean",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "queryable": {
                "description": "Чи дозволяти публічні запити записів із цим статусом.",
                "type": "boolean",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "show_in_list": {
                "description": "Чи включати записи до списку редагування для їх типів запису.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "slug": {
                "description": "Літерно-цифровий ідентифікатор статусу.",
                "type": "string",
                "context": [
                    "embed",
                    "view",
                    "edit"
                ],
                "readonly": true
            }
        }
    },
    "_links": {
        "self": "http://wptest.ru/wp-json/wp/v2/statuses"
    }
}

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

GitHub

{
    "namespace": "wp/v2",
    "methods": [
        "GET"
    ],
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "args": {
                "status": {
                    "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": "status",
        "type": "object",
        "properties": {
            "name": {
                "description": "Назва статусу.",
                "type": "string",
                "context": [
                    "embed",
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "private": {
                "description": "Чи мають записи з цим статусом бути особистими.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "protected": {
                "description": "Чи мають бути захищені записи з цим статусом.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "public": {
                "description": "Чи показувати записи з цим статусом на частині сайту для відвідувачів.",
                "type": "boolean",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "queryable": {
                "description": "Чи дозволяти публічні запити записів із цим статусом.",
                "type": "boolean",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "show_in_list": {
                "description": "Чи включати записи до списку редагування для їх типів запису.",
                "type": "boolean",
                "context": [
                    "edit"
                ],
                "readonly": true
            },
            "slug": {
                "description": "Літерно-цифровий ідентифікатор статусу.",
                "type": "string",
                "context": [
                    "embed",
                    "view",
                    "edit"
                ],
                "readonly": true
            }
        }
    }
}

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

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

Вид запиту

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

GET /wp/v2/statuses

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

context
(рядок)

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

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

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

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

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

Відповідь:

{
	"publish": {
		"name": "Опубліковано",
		"public": true,
		"queryable": true,
		"slug": "publish",
		"_links": {
			"archives": [
				{
					"href": "http://example.com/wp-json/wp/v2/posts"
				}
			]
		}
	},
	"future": {
		"name": "Заплановано",
		"public": false,
		"queryable": false,
		"slug": "future",
		"_links": {
			"archives": [
				{
					"href": "http://example.com/wp-json/wp/v2/posts?status=future"
				}
			]
		}
	},
	"draft": {
		"name": "Чернетка",
		"public": false,
		"queryable": false,
		"slug": "draft",
		"_links": {
			"archives": [
				{
					"href": "http://example.com/wp-json/wp/v2/posts?status=draft"
				}
			]
		}
	},
	"pending": {
		"name": "На затвердженні",
		"public": false,
		"queryable": false,
		"slug": "pending",
		"_links": {
			"archives": [
				{
					"href": "http://example.com/wp-json/wp/v2/posts?status=pending"
				}
			]
		}
	},
	"private": {
		"name": "Особисте",
		"public": false,
		"queryable": false,
		"slug": "private",
		"_links": {
			"archives": [
				{
					"href": "http://example.com/wp-json/wp/v2/posts?status=private"
				}
			]
		}
	},
	"trash": {
		"name": "У кошику",
		"public": false,
		"queryable": false,
		"slug": "trash",
		"_links": {
			"archives": [
				{
					"href": "http://example.com/wp-json/wp/v2/posts?status=trash"
				}
			]
		}
	}
}

Отримання вказаного статусу запису

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

Вид запиту

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

GET /wp/v2/statuses/{status}

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

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

Назва статусу.

context
(рядок)

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

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

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

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

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

Відповідь:

{
	"name": "Опубліковано",
	"public": true,
	"queryable": true,
	"slug": "publish",
	"_links": {
		"archives": [
			{
				"href": "http://example.com/wp-json/wp/v2/posts"
			}
		]
	}
}