Получить метаданные сайта

GET

/wp-json/wp2/site-manager/v1/sites/{blog_id}

curl --request GET \
  --url https://example.com/wp-json/wp2/site-manager/v1/sites/1 \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Метаданные одного сайта: blogname, слаг, флаги WP_Site, статус/категории Site Manager. Не содержимое записей. Нужно право управлять этим блогом (manage_network / супер-админ / manage_options на сайте). Чужой сайт сети без права — 403 forbidden.

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

blog_id

required

integer

ID сайта в текущей сети (WP_Site->blog_id). Сайт из другой сети — 404 site_not_in_network.

Query Parameters

include

string

Если строка содержит stats, в ответ добавляется user_count. Иначе PHP поле не отдаёт.

Responses

200

Тело — SiteMetadata::to_array.

Media typeapplication/json

object

blog_id

ID сайта в текущей сети (WP_Site->blog_id). Path {blog_id} тех же ручек — то же число.

integer

network_id

ID сети, которой принадлежит сайт (WP_Site->site_id). Это не blog_id и не CreateNetworkRequest.domain.

integer

title

Заголовок сайта — опция блога blogname (get_option на этом сайте). Не опция сети site_name.

string

slug

Адресный ярлык сайта. При SUBDOMAIN_INSTALL — поддомен относительно domain сети; иначе сегмент WP_Site->path без слэшей. PHP считает его в SiteSlugService::derive_slug_from_site.

string

domain

Хост сайта в таблице блогов (WP_Site->domain), без схемы https://.

string

path

Путь сайта в таблице блогов (WP_Site->path) со слэшами (часто / при поддоменах или /training/ при subdirectory). Это не путь файла Local Sync.

string

description

Подзаголовок сайта — опция блога blogdescription.

string

status_id

ID термина таксономии статусов Site Manager (site meta wp2platform_site_status). null, если статус не задан или id=0.

integer

nullable

status

Развёрнутый термин статуса Site Manager. null, если статус не задан. Не путать с флагом WP_Site->public.

object

id

Term_id статуса.

integer

name

Отображаемое имя статуса.

string

slug

Ярлык термина статуса (sanitize_title).

string

category_ids

ID терминов категорий Site Manager (site meta wp2platform_site_categories).

Array<integer>

categories

Развёрнутые категории сайта (id, name, slug). Во вложении SiteDto PHP не отдаёт parent.

Array<object>

object

id

Term_id категории сайтов (таксономия Site Manager, не рубрика записей).

integer

name

Отображаемое имя термина. В списке PHP может подменить дефолтные ярлыки через translate_default_term_label.

string

slug

Ярлык термина категории (sanitize_title при записи).

string

parent

Term_id родителя (WP_Term->parent); 0 — корень. В SiteDto.categories PHP это поле не кладёт.

integer

site_url

Публичный URL сайта (get_site_url(blog_id)).

string format: uri

admin_url

URL wp-admin этого сайта (get_admin_url(blog_id)), не /wp-admin/network/.

string format: uri

registered

Дата регистрации блога (WP_Site->registered), как хранит ядро.

string format: date-time

last_updated

Дата последнего обновления блога (WP_Site->last_updated).

string format: date-time

public

Флаг WP_Site->public (1 — публичный/активный, 0 — снят с публикации). Не термин статуса Site Manager.

integer

archived

Флаг WP_Site->archived (1 — в архиве, 0 — нет).

integer

deleted

Флаг WP_Site->deleted в таблице блогов (ядро пометило сайт удалённым). Не результат DELETE этой API.

integer

spam

Флаг WP_Site->spam (1 — помечен как спам).

integer

mature

Флаг WP_Site->mature.

integer

is_main_site

True, если это главный сайт сети (is_main_site(blog_id)). Его нельзя удалить, архивировать, деактивировать или сменить ему slug через API (main_site_forbidden / main_site_slug_forbidden).

boolean

is_template

True, если site meta wp2platform_site_manager_is_template равно 1 (сайт-шаблон для дублирования).

boolean

user_count

Число пользователей на сайте (count_users()['total_users']). PHP добавляет поле, только если в query include есть подстрока stats; иначе ключа нет.

integer

Example

{
  "blog_id": 5,
  "network_id": 1,
  "title": "Учебный проект",
  "slug": "training",
  "domain": "training.example.com",
  "path": "/",
  "public": 1,
  "archived": 0,
  "is_main_site": false,
  "is_template": false
}

401

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

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Нет права на этот блог (forbidden) или невалидный REST nonce.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

404

Site_not_in_network — сайт не в текущей сети; site_not_found — нет такого блога.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}