class.wpcom-json-api-get-site-v1-2-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.2.4

jetpack / json-endpoints / class.wpcom-json-api-get-site-v1-2-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-get-site-v1-2-endpoint.php

117 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	new WPCOM_JSON_API_GET_Site_V1_2_Endpoint(
4	array(
5	'description' => 'Get information about a site.',
6	'group' => 'sites',
7	'stat' => 'sites:X',
8	'allowed_if_flagged' => true,
9	'method' => 'GET',
10	'min_version' => '1.2',
11	'path' => '/sites/%s',
12	'path_labels' => array(
13	'$site' => '(int\|string) Site ID or domain',
14	),
15
16	'allow_fallback_to_jetpack_blog_token' => true,
17
18	'query_parameters' => array(
19	'context' => false,
20	'filters' => '(string) Optional. Returns sites that satisfy the given filters only. Example: filters=jetpack,atomic,wpcom',
21	),
22
23	'response_format' => WPCOM_JSON_API_GET_Site_V1_2_Endpoint::$site_format,
24
25	'example_request' => 'https://public-api.wordpress.com/rest/v1.2/sites/en.blog.wordpress.com/',
26	)
27	);
28
29	/**
30	* GET Site v1_2 endpoint.
31	*/
32	class WPCOM_JSON_API_GET_Site_V1_2_Endpoint extends WPCOM_JSON_API_GET_Site_Endpoint {
33
34	/**
35	* Site format array.
36	*
37	* @var array $site_format
38	*/
39	public static $site_format = array(
40	'ID' => '(int) Site ID',
41	'name' => '(string) Title of site',
42	'description' => '(string) Tagline or description of site',
43	'URL' => '(string) Full URL to the site',
44	'capabilities' => '(array) Array of capabilities for the current user on this site.',
45	'jetpack' => '(bool) Whether the site is a Jetpack site or not',
46	'jetpack_connection' => '(bool) Whether the site is connected to WP.com via `jetpack-connection`',
47	'is_multisite' => '(bool) Whether the site is a Multisite site or not. Always true for WP.com sites.',
48	'site_owner' => '(int) User ID of the site owner',
49	'post_count' => '(int) The number of posts the site has',
50	'subscribers_count' => '(int) The number of subscribers the site has',
51	'locale' => '(string) Primary locale code of the site',
52	'icon' => '(array) An array of icon formats for the site',
53	'logo' => '(array) The site logo, set in the Customizer',
54	'visible' => '(bool) If this site is visible in the user\'s site list',
55	'is_private' => '(bool) If the site is a private site or not',
56	'is_coming_soon' => '(bool) If the site is a "coming soon" site or not',
57	'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.',
58	'is_vip' => '(bool) If the site is a VIP site or not.',
59	'is_following' => '(bool) If the current user is subscribed to this site in the reader',
60	'organization_id' => '(int) P2 Organization identifier.',
61	'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/',
62	'plan' => '(array) Details of the current plan for this site.',
63	'products' => '(array) Details of the current products for this site.',
64	'zendesk_site_meta' => '(array) Site meta data for Zendesk.',
65	'updates' => '(array) An array of available updates for plugins, themes, wordpress, and languages.',
66	'jetpack_modules' => '(array) A list of active Jetpack modules.',
67	'meta' => '(object) Meta data',
68	'quota' => '(array) An array describing how much space a user has left for uploads',
69	'launch_status' => '(string) A string describing the launch status of a site',
70	'site_migration' => '(array) Data about any migration into the site.',
71	'is_fse_active' => '(bool) If the site has Full Site Editing active or not.',
72	'is_fse_eligible' => '(bool) If the site is capable of Full Site Editing or not',
73	'is_core_site_editor_enabled' => '(bool) If the site has the core site editor enabled.',
74	'is_wpcom_atomic' => '(bool) If the site is a WP.com Atomic one.',
75	'is_wpcom_staging_site' => '(bool) If the site is a WP.com staging site.',
76	'was_ecommerce_trial' => '(bool) If the site ever used an eCommerce trial.',
77	'was_upgraded_from_trial' => '(bool) If the site ever upgraded to a paid plan from a trial.',
78	'was_migration_trial' => '(bool) If the site ever used a migration trial.',
79	'was_hosting_trial' => '(bool) If the site ever used a hosting trial.',
80	);
81
82	/**
83	*
84	* API callback.
85	*
86	* @param string $path - the path.
87	* @param int $blog_id - the blog ID.
88	*/
89	public function callback( $path = '', $blog_id = 0 ) {
90	add_filter( 'sites_site_format', array( $this, 'site_format' ) );
91
92	// Site filtering is a WPCOM concept, once a request gets anywhere else it should just be returned
93	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
94	// Apply filter here, return same error as switch_to_blog_and_validate_user if blog is not found.
95	require_lib( 'site-filter' );
96	$filters = Site_Filter::process_query_arg( $this->query_args() );
97	if ( is_wp_error( $filters ) ) {
98	return $filters;
99	}
100	if ( ! empty( $filters ) && ! Site_Filter::filter_blog( $this->api->get_blog_id( $blog_id ), $filters ) ) {
101	return new WP_Error( 'unknown_blog', 'Unknown blog', 404 );
102	}
103	}
104
105	return parent::callback( $path, $blog_id );
106	}
107
108	/**
109	* Site format.
110	*
111	* @param string $format - the format.
112	*/
113	public function site_format( $format ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
114	return self::$site_format;
115	}
116	}
117