GET/sites/$site
Get information about a site.
Resource Information
| Method | GET |
|---|---|
| URL | https://public-api.wordpress.com/rest/v1.1/sites/$site |
| Requires authentication? | No |
Method Parameters
| Parameter | Type | Description |
|---|---|---|
| $site | (int|string) | Site ID or domain |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| http_envelope | (bool) |
|
| pretty | (bool) |
|
| meta | (string) | Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes |
| fields | (string) | Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title |
| callback | (string) | An optional JSONP callback function. |
| options | (string) | Optional. Returns specified options only. Comma-separated list. Example: options=login_url,timezone |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| ID | (int) | Site ID |
| name | (string) | Title of site |
| description | (string) | Tagline or description of site |
| URL | (string) | Full URL to the site |
| user_can_manage | (bool) | The current user can manage this site |
| capabilities | (array) | Array of capabilities for the current user on this site. |
| jetpack | (bool) | Whether the site is a Jetpack site or not |
| jetpack_connection | (bool) | Whether the site is connected to WP.com via `jetpack-connection` |
| is_multisite | (bool) | Whether the site is a Multisite site or not. Always true for WP.com sites. |
| site_owner | (int) | User ID of the site owner |
| post_count | (int) | The number of posts the site has |
| subscribers_count | (int) | The number of subscribers the site has |
| lang | (string) | Primary language code of the site |
| icon | (array) | An array of icon formats for the site |
| logo | (array) | The site logo, set in the Customizer |
| visible | (bool) | If this site is visible in the user's site list |
| is_private | (bool) | If the site is a private site or not |
| is_coming_soon | (bool) | If the site is marked as "coming soon" or not |
| single_user_site | (bool) | Whether the site is single user. Only returned for WP.com sites and for Jetpack sites with version 3.4 or higher. |
| is_vip | (bool) | If the site is a VIP site or not. |
| is_following | (bool) | If the current user is subscribed to this site in the reader |
| organization_id | (int) | P2 Organization identifier. |
| options | (array) | An array of options/settings for the blog. Only viewable by users with post editing rights to the site. Note: Post formats is deprecated, please see /sites/$id/post-formats/ |
| p2_thumbnail_elements | (array) | Details used to render a thumbnail of the site. P2020 themed sites only. |
| plan | (array) | Details of the current plan for this site. |
| products | (array) | Details of the current products for this site. |
| zendesk_site_meta | (array) | Site meta data for Zendesk. |
| updates | (array) | An array of available updates for plugins, themes, wordpress, and languages. |
| jetpack_modules | (array) | A list of active Jetpack modules. |
| meta | (object) | Meta data |
| quota | (array) | An array describing how much space a user has left for uploads |
| launch_status | (string) | A string describing the launch status of a site |
| site_migration | (array) | Data about any migration into the site. |
| is_fse_active | (bool) | If the site has Full Site Editing active or not. |
| is_fse_eligible | (bool) | If the site is capable of Full Site Editing or not |
| is_core_site_editor_enabled | (bool) | If the site has the core site editor enabled. |
| is_wpcom_atomic | (bool) | If the site is a WP.com Atomic one. |
| is_wpcom_staging_site | (bool) | If the site is a WP.com staging site. |
| user_interactions | (array) | An array of user interactions with a site. |
| was_ecommerce_trial | (bool) | If the site ever used an eCommerce trial. |
| was_upgraded_from_trial | (bool) | If the site ever upgraded to a paid plan from a trial. |
| was_migration_trial | (bool) | If the site ever used a migration trial. |
| was_hosting_trial | (bool) | If the site ever used a hosting trial. |
| wpcom_site_setup | (string) | The WP.com site setup identifier. |
| is_deleted | (bool) | If the site flagged as deleted. |
Resource Errors
This endpoint does not return any errors.
Example
curl 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/'
<?php
$options = array (
'http' =>
array (
'ignore_errors' => true,
),
);
$context = stream_context_create( $options );
$response = file_get_contents(
'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/',
false,
$context
);
$response = json_decode( $response );
?>
