Получить список страниц курса для сборок

GET

/wp-json/wp2lms/static-builder/v1/pages

curl --request GET \
  --url 'https://example.com/wp-json/wp2lms/static-builder/v1/pages?blog_id=1' \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Возвращает каталог записей post_type=page выбранного сайта, которые можно передать в page_ids при создании или обновлении статической сборки. PHP: PageCatalog::list_pages() — get_posts со статусами publish, draft, private, pending; сортировка menu_order ASC; без пагинации (numberposts=-1). Это не список уже сохранённых сборок и не запуск генерации. Пустой pages — валидный 200 (на сайте нет страниц). Query blog_id необязателен: по умолчанию get_current_blog_id(). На мультисайте PHP переключается на этот блог (switch_to_blog), если он в текущей сети. Нужно manage_network (мультисайт) или edit_pages (одиночный сайт). Cookie + X-WP-Nonce или Application Password.

Authorizations

• cookie
• applicationPassword

Parameters

Query Parameters

blog_id

integer

>= 1

ID сайта мультисети, на котором читать/писать сборки. Необязательно: PHP берёт get_current_blog_id(). ≤ 0 — 400 invalid_blog. Чужой/несуществующий сайт — 404 blog_not_found. На одиночном сайте обычно не передают.

Example

1

Responses

200

Каталог страниц сайта. Тело: blog_id (после резолва) и массив pages с id, title, slug, menu_order, status.

Media typeapplication/json

object

blog_id

Сайт, с которого прочитан каталог (после resolve_blog_id / switch_to_blog).

integer

pages

Все подходящие страницы сайта, без пагинации.

Array<object>

object

id

ID страницы WordPress (WP_Post->ID, post_type=page). Это значение кладут в page_ids сборки.

integer

title

Заголовок страницы (get_the_title).

string

slug

Ярлык записи (post_name).

string

menu_order

Порядок в меню WP (menu_order); каталог отсортирован по этому полю по возрастанию.

integer

status

Post_status страницы: publish, draft, private или pending — как отдал get_posts.

string

Example

{
  "blog_id": 1,
  "pages": [
    {
      "id": 42,
      "title": "Введение",
      "slug": "vvedenie",
      "menu_order": 0,
      "status": "publish"
    },
    {
      "id": 57,
      "title": "Модуль 1",
      "slug": "modul-1",
      "menu_order": 1,
      "status": "draft"
    }
  ]
}

400

Wp2lms_static_builder_invalid_blog — blog_id ≤ 0 после приведения к int.

Media typeapplication/json

object

code

Машинный код WP_Error (например wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Человекочитаемое сообщение ошибки из PHP / WordPress REST.

string

data

Обычно { status: <HTTP-код> }. Если status нет, ядро REST часто отдаёт 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

401

Не аутентифицирован. DualRest: rest_forbidden (status 401), если нет cookie-сессии. Cookie + X-WP-Nonce или Application Password.

Media typeapplication/json

object

code

Машинный код WP_Error (например wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Человекочитаемое сообщение ошибки из PHP / WordPress REST.

string

data

Обычно { status: <HTTP-код> }. Если status нет, ядро REST часто отдаёт 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

403

Нет права manage_network (мультисайт) или edit_pages (одиночный сайт); невалидный REST nonce rest_cookie_invalid_nonce.

Media typeapplication/json

object

code

Машинный код WP_Error (например wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Человекочитаемое сообщение ошибки из PHP / WordPress REST.

string

data

Обычно { status: <HTTP-код> }. Если status нет, ядро REST часто отдаёт 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}

404

Wp2lms_static_builder_blog_not_found — сайта нет или он в другой сети (get_site; сравнение site_id с текущей сетью).

Media typeapplication/json

object

code

Машинный код WP_Error (например wp2lms_static_builder_busy, rest_forbidden, invalid_nonce).

string

message

Человекочитаемое сообщение ошибки из PHP / WordPress REST.

string

data

Обычно { status: <HTTP-код> }. Если status нет, ядро REST часто отдаёт 500.

object

key

additional properties

any

Example

{
  "code": "wp2lms_static_builder_busy",
  "message": "Build is currently building and cannot be updated.",
  "data": {
    "status": 409
  }
}