PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 16.3-a.7
Jetpack – WP Security, Backup, Speed, & Growth v16.3-a.7
16.3-a.5 16.3-a.7 16.3-a.3 16.3-a.1 16.2 16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 All 506 releases
← All changes | json-endpoints/class.wpcom-json-api-get-site-endpoint.php +201 -10 13.6.2 → 16.3-a.7 View file →
@@ -1,6 +1,10 @@
1 1 <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2 2
3 +if ( ! defined( 'ABSPATH' ) ) {
4 + exit( 0 );
5 +}
6 +
3 7 new WPCOM_JSON_API_GET_Site_Endpoint(
4 8 array(
5 9 'description' => 'Get information about a site.',
6 10 'group' => 'sites',
@@ -12,8 +16,10 @@
12 16 'path' => '/sites/%s',
13 17 'path_labels' => array(
14 18 '$site' => '(int|string) Site ID or domain',
15 19 ),
20 + 'rest_route' => '/site',
21 + 'rest_min_jp_version' => '15.9',
16 22 'allow_jetpack_site_auth' => true,
17 23
18 24 'allow_fallback_to_jetpack_blog_token' => true,
19 25
@@ -29,8 +35,10 @@
29 35 );
30 36
31 37 /**
32 38 * GET Site endpoint class.
39 + *
40 + * @phan-constructor-used-for-side-effects
33 41 */
34 42 class WPCOM_JSON_API_GET_Site_Endpoint extends WPCOM_JSON_API_Endpoint {
35 43
36 44 /**
@@ -39,8 +47,9 @@
39 47 * @var array $site_format
40 48 */
41 49 public static $site_format = array(
42 50 'ID' => '(int) Site ID',
51 + 'slug' => '(string) Slug of site',
43 52 'name' => '(string) Title of site',
44 53 'description' => '(string) Tagline or description of site',
45 54 'URL' => '(string) Full URL to the site',
46 55 'user_can_manage' => '(bool) The current user can manage this site', // deprecated.
@@ -83,8 +92,19 @@
83 92 'was_migration_trial' => '(bool) If the site ever used a migration trial.',
84 93 'was_hosting_trial' => '(bool) If the site ever used a hosting trial.',
85 94 'wpcom_site_setup' => '(string) The WP.com site setup identifier.',
86 95 'is_deleted' => '(bool) If the site flagged as deleted.',
96 + 'is_a4a_client' => '(bool) If the site is an A4A client site.',
97 + 'is_a4a_dev_site' => '(bool) If the site is an A4A dev site.',
98 + 'is_garden' => '(bool) If the site is a Garden site.',
99 + 'garden_name' => '(string) The name of the Garden site.',
100 + 'garden_partner' => '(string) The partner of the Garden site.',
101 + 'garden_is_provisioned' => '(bool) If the Garden site is provisioned.',
102 + 'is_wpcom_flex' => '(bool) If the site is a Flex site',
103 + 'big_sky_enabled' => '(bool) Whether the Big Sky AI assistant is enabled for this site.',
104 + 'atomic_email_block' => '(object) State of the block on the site\'s outgoing email, with `status` (`blocked` while a block is active, `at_risk` once it has expired), `reason` and `expires_on` keys, or null when the site has no block history. WordPress.com platform only.',
105 + 'hosting_provider_guess' => '(string) Guess of the hosting provider. WordPress.com platform only; only returned when explicitly requested via the fields parameter.',
106 + 'environment_type' => '(string) The WP_ENVIRONMENT_TYPE of the site as synced by Jetpack. WordPress.com platform only; only returned when explicitly requested via the fields parameter.',
87 107 );
88 108
89 109 /**
90 110 * No member fields.
@@ -117,8 +137,14 @@
117 137 'is_core_site_editor_enabled',
118 138 'is_wpcom_atomic',
119 139 'is_wpcom_staging_site',
120 140 'is_deleted',
141 + 'is_wpcom_flex',
142 + 'is_a4a_client',
143 + 'is_a4a_dev_site',
144 + 'is_garden',
145 + 'big_sky_enabled',
146 + 'garden_name',
121 147 );
122 148
123 149 /**
124 150 * Site options.
@@ -137,8 +163,9 @@
137 163 'is_redirect',
138 164 'unmapped_url',
139 165 'featured_images_enabled',
140 166 'theme_slug',
167 + 'theme_errors',
141 168 'header_image',
142 169 'background_color',
143 170 'image_default_link_type',
144 171 'image_thumbnail_width',
@@ -197,15 +224,19 @@
197 224 'anchor_podcast',
198 225 'was_created_with_blank_canvas_design',
199 226 'videopress_storage_used',
200 227 'is_difm_lite_in_progress',
228 + 'difm_lite_site_options',
229 + 'is_gating_business_q1',
230 + 'is_legacy_gating_site',
201 231 'site_intent',
202 - 'site_goals',
232 + 'site_partner_bundle',
203 233 'onboarding_segment',
204 234 'site_vertical_id',
205 235 'blogging_prompts_settings',
206 236 'launchpad_screen',
207 237 'launchpad_checklist_tasks_statuses',
238 + 'migration_source_site_domain',
208 239 'wpcom_production_blog_id',
209 240 'wpcom_staging_blog_ids',
210 241 'can_blaze',
211 242 'wpcom_site_setup',
@@ -212,8 +243,14 @@
212 243 'is_commercial',
213 244 'is_commercial_reasons',
214 245 'wpcom_admin_interface',
215 246 'wpcom_classic_early_release',
247 + 'jetpack_recovery_mode_status',
248 + 'jetpack_sso_require_two_step',
249 + 'apm_enabled',
250 + 'wpcom_ai_launchpad_enabled',
251 + 'wpcom_ai_launchpad_dismissed',
252 + 'wpcom_ai_launchpad_completed',
216 253 );
217 254
218 255 /**
219 256 * Jetpack response fields.
@@ -220,8 +257,9 @@
220 257 *
221 258 * @var array $jetpack_response_field_additions
222 259 */
223 260 protected static $jetpack_response_field_additions = array(
261 + 'slug',
224 262 'subscribers_count',
225 263 'site_migration',
226 264 'site_owner',
227 265 'is_wpcom_staging_site',
@@ -228,8 +266,16 @@
228 266 'was_ecommerce_trial',
229 267 'was_migration_trial',
230 268 'was_hosting_trial',
231 269 'was_upgraded_from_trial',
270 + 'is_a4a_dev_site',
271 + 'is_garden',
272 + 'garden_name',
273 + 'garden_partner',
274 + 'garden_is_provisioned',
275 + 'is_wpcom_flex',
276 + 'big_sky_enabled',
277 + 'atomic_email_block',
232 278 );
233 279
234 280 /**
235 281 * Jetpack response field member additions.
@@ -245,9 +291,9 @@
245 291
246 292 /**
247 293 * Jetpack response option additions.
248 294 *
249 - * @var array $jetpack_response_field_member_additions
295 + * @var array $jetpack_response_option_additions
250 296 */
251 297 protected static $jetpack_response_option_additions = array(
252 298 'publicize_permanently_disabled',
253 299 'ak_vp_bundle_enabled',
@@ -274,8 +320,11 @@
274 320 'is_commercial',
275 321 'is_commercial_reasons',
276 322 'wpcom_admin_interface',
277 323 'wpcom_classic_early_release',
324 + 'jetpack_recovery_mode_status',
325 + 'jetpack_sso_require_two_step',
326 + 'apm_enabled',
278 327 );
279 328
280 329 /**
281 330 * Current enabled trials.
@@ -288,9 +337,9 @@
288 337 'was_hosting_trial' => 'hosting',
289 338 );
290 339
291 340 /**
292 - * Site
341 + * Site.
293 342 *
294 343 * @var SAL_Site $site.
295 344 */
296 345 private $site;
@@ -315,10 +364,12 @@
315 364 *
316 365 * /sites/mine
317 366 * /sites/%s -> $blog_id\
318 367 *
319 - * @param string $path - the path.
320 - * @param int $blog_id - the blog ID.
368 + * @param string $path - the path.
369 + * @param int|string $blog_id - the blog ID or the string 'mine'.
370 + *
371 + * @return array|\WP_Error Site response array on success, or WP_Error on failure.
321 372 */
322 373 public function callback( $path = '', $blog_id = 0 ) {
323 374 if ( 'mine' === $blog_id ) {
324 375 $api = WPCOM_JSON_API::init();
@@ -454,8 +505,11 @@
454 505 switch ( $key ) {
455 506 case 'ID':
456 507 $response[ $key ] = $this->site->blog_id;
457 508 break;
509 + case 'slug':
510 + $response[ $key ] = $this->site->get_slug();
511 + break;
458 512 case 'name':
459 513 $response[ $key ] = $this->site->get_name();
460 514 break;
461 515 case 'description':
@@ -605,8 +659,51 @@
605 659 break;
606 660 case 'is_deleted':
607 661 $response[ $key ] = $this->site->is_deleted();
608 662 break;
663 + case 'is_a4a_client':
664 + $response[ $key ] = $this->site->is_a4a_client();
665 + break;
666 + case 'is_a4a_dev_site':
667 + $response[ $key ] = $this->site->is_a4a_dev_site();
668 + break;
669 + case 'is_garden':
670 + $response[ $key ] = $this->site->is_garden();
671 + break;
672 + case 'garden_name':
673 + $response[ $key ] = $this->site->garden_name();
674 + break;
675 + case 'garden_partner':
676 + $response[ $key ] = $this->site->garden_partner();
677 + break;
678 + case 'garden_is_provisioned':
679 + $response[ $key ] = $this->site->garden_is_provisioned();
680 + break;
681 + case 'is_wpcom_flex':
682 + $response[ $key ] = $this->site->is_wpcom_flex();
683 + break;
684 + case 'big_sky_enabled':
685 + $response[ $key ] = $this->site->is_big_sky_enabled();
686 + break;
687 + case 'atomic_email_block':
688 + $response[ $key ] = $this->site->get_atomic_email_block();
689 + break;
690 + case 'hosting_provider_guess':
691 + // WordPress.com platform decoration, computed only when explicitly requested
692 + // via `fields` so default `_all` responses are unchanged.
693 + if ( $this->is_wpcom()
694 + && function_exists( 'get_jetpack_hosting_provider' )
695 + && is_array( $this->fields_to_include ) ) {
696 + $response[ $key ] = get_jetpack_hosting_provider( get_current_blog_id() );
697 + }
698 + break;
699 + case 'environment_type':
700 + // WordPress.com platform decoration, computed only when explicitly requested
701 + // via `fields` so default `_all` responses are unchanged.
702 + if ( $this->is_wpcom() && is_array( $this->fields_to_include ) ) {
703 + $response[ $key ] = $this->get_site_environment_type();
704 + }
705 + break;
609 706 }
610 707
611 708 do_action( 'post_render_site_response_key', $key );
612 709 }
@@ -656,8 +753,11 @@
656 753 break;
657 754 case 'theme_slug':
658 755 $options[ $key ] = $site->get_theme_slug();
659 756 break;
757 + case 'theme_errors':
758 + $options[ $key ] = $site->get_theme_errors();
759 + break;
660 760 case 'header_image':
661 761 $options[ $key ] = $site->get_header_image();
662 762 break;
663 763 case 'background_color':
@@ -859,11 +959,26 @@
859 959 break;
860 960 case 'is_difm_lite_in_progress':
861 961 $options[ $key ] = $site->is_difm_lite_in_progress();
862 962 break;
963 + case 'difm_lite_site_options':
964 + $difm_lite_site_options = $site->get_difm_lite_site_options();
965 + if ( null !== $difm_lite_site_options ) {
966 + $options[ $key ] = (object) $difm_lite_site_options;
967 + }
968 + break;
969 + case 'is_gating_business_q1':
970 + $options[ $key ] = $site->is_gating_business_q1();
971 + break;
972 + case 'is_legacy_gating_site':
973 + $options[ $key ] = $site->is_legacy_gating_site();
974 + break;
863 975 case 'site_intent':
864 976 $options[ $key ] = $site->get_site_intent();
865 977 break;
978 + case 'site_partner_bundle':
979 + $options[ $key ] = $site->get_site_partner_bundle();
980 + break;
866 981 case 'site_goals':
867 982 $options[ $key ] = $site->get_site_goals();
868 983 break;
869 984 case 'onboarding_segment':
@@ -882,8 +997,11 @@
882 997 break;
883 998 case 'launchpad_checklist_tasks_statuses':
884 999 $options[ $key ] = $site->get_launchpad_checklist_tasks_statuses();
885 1000 break;
1001 + case 'migration_source_site_domain':
1002 + $options[ $key ] = $site->get_migration_source_site_domain();
1003 + break;
886 1004 case 'wpcom_production_blog_id':
887 1005 $options[ $key ] = $site->get_wpcom_production_blog_id();
888 1006 break;
889 1007 case 'wpcom_staging_blog_ids':
@@ -906,8 +1024,26 @@
906 1024 break;
907 1025 case 'wpcom_classic_early_release':
908 1026 $options[ $key ] = $site->get_wpcom_classic_early_release();
909 1027 break;
1028 + case 'jetpack_recovery_mode_status':
1029 + $options[ $key ] = $site->get_jetpack_recovery_mode_status();
1030 + break;
1031 + case 'jetpack_sso_require_two_step':
1032 + $options[ $key ] = $site->get_jetpack_sso_require_two_step();
1033 + break;
1034 + case 'apm_enabled':
1035 + $options[ $key ] = $site->get_apm_enabled();
1036 + break;
1037 + case 'wpcom_ai_launchpad_enabled':
1038 + $options[ $key ] = $site->is_ai_launchpad_enabled();
1039 + break;
1040 + case 'wpcom_ai_launchpad_dismissed':
1041 + $options[ $key ] = $site->is_ai_launchpad_dismissed();
1042 + break;
1043 + case 'wpcom_ai_launchpad_completed':
1044 + $options[ $key ] = $site->is_ai_launchpad_completed();
1045 + break;
910 1046 }
911 1047 }
912 1048
913 1049 return $options;
@@ -939,14 +1075,20 @@
939 1075
940 1076 /**
941 1077 * Apply any WPCOM-only response components to a Jetpack site response.
942 1078 *
943 - * @param array $response - the response.
1079 + * @param object $response - the response.
944 1080 */
945 1081 public function decorate_jetpack_response( &$response ) {
1082 + $this->filter_fields_and_options();
946 1083 $this->site = $this->get_platform()->get_site( $response->ID );
947 1084 switch_to_blog( $this->site->get_id() );
948 1085
1086 + // Allow the SAL site to apply its own overrides to the proxied response.
1087 + if ( method_exists( $this->site, 'decorate_jetpack_response' ) ) {
1088 + $this->site->decorate_jetpack_response( $response ); // @phan-suppress-current-line PhanUndeclaredMethod -- checked via method_exists().
1089 + }
1090 +
949 1091 $wpcom_response = $this->render_response_keys( self::$jetpack_response_field_additions );
950 1092
951 1093 foreach ( $wpcom_response as $key => $value ) {
952 1094 $response->{ $key } = $value;
@@ -951,9 +1093,11 @@
951 1093 foreach ( $wpcom_response as $key => $value ) {
952 1094 $response->{ $key } = $value;
953 1095 }
954 1096
955 - if ( $this->has_user_access() || $this->has_blog_access( $this->api->token_details ) ) {
1097 + $has_site_access = $this->has_user_access() || $this->has_blog_access( $this->api->token_details );
1098 +
1099 + if ( $has_site_access ) {
956 1100 $wpcom_member_response = $this->render_response_keys( self::$jetpack_response_field_member_additions );
957 1101
958 1102 foreach ( $wpcom_member_response as $key => $value ) {
959 1103 $response->{ $key } = $value;
@@ -972,8 +1116,9 @@
972 1116 unset( $response->site_owner );
973 1117 unset( $response->plan );
974 1118 unset( $response->products );
975 1119 unset( $response->zendesk_site_meta );
1120 + unset( $response->atomic_email_block );
976 1121 }
977 1122
978 1123 // render additional options.
979 1124 if ( isset( $response->options ) && $response->options ) {
@@ -981,13 +1126,18 @@
981 1126
982 1127 // Remove heic from jetpack (and atomic) sites so that the iOS app know to convert the file format into a JPEG.
983 1128 // heic fromat is currently not supported by for uploading.
984 1129 // See https://jetpackp2.wordpress.com/2020/08/19/image-uploads-in-the-wp-ios-app-broken
985 - if ( $this->site->is_jetpack() && isset( $response->options['allowed_file_types'] ) ) {
1130 + if (
1131 + $this->site->is_jetpack()
1132 + && isset( $response->options['allowed_file_types'] )
1133 + && is_array( $response->options['allowed_file_types'] )
1134 + ) {
1135 + $allowed_file_types = (array) $response->options['allowed_file_types'];
986 1136 $remove_file_types = array(
987 1137 'heic',
988 1138 );
989 - $response->options['allowed_file_types'] = array_values( array_diff( $response->options['allowed_file_types'], $remove_file_types ) );
1139 + $response->options['allowed_file_types'] = array_values( array_diff( $allowed_file_types, $remove_file_types ) );
990 1140 }
991 1141
992 1142 foreach ( $wpcom_options_response as $key => $value ) {
993 1143 $response->options[ $key ] = $value;
@@ -993,11 +1143,44 @@
993 1143 $response->options[ $key ] = $value;
994 1144 }
995 1145 }
996 1146
1147 + // WordPress.com platform fields are not part of proxied Jetpack responses;
1148 + // add them only when explicitly requested.
1149 + if ( $this->is_wpcom() && $has_site_access && is_array( $this->fields_to_include ) ) {
1150 + if ( function_exists( 'get_jetpack_hosting_provider' ) && in_array( 'hosting_provider_guess', $this->fields_to_include, true ) ) {
1151 + $response->hosting_provider_guess = get_jetpack_hosting_provider( get_current_blog_id() );
1152 + }
1153 + if ( in_array( 'environment_type', $this->fields_to_include, true ) ) {
1154 + $response->environment_type = $this->get_site_environment_type();
1155 + }
1156 + }
1157 +
997 1158 restore_current_blog();
998 1159 return $response; // possibly no need since it's modified in place.
999 1160 }
1161 +
1162 + /**
1163 + * Whether this request is running on the WordPress.com platform.
1164 + *
1165 + * @return bool
1166 + */
1167 + protected function is_wpcom() {
1168 + return ( new \Automattic\Jetpack\Status\Host() )->is_wpcom_platform();
1169 + }
1170 +
1171 + /**
1172 + * Get the site's synced WP_ENVIRONMENT_TYPE.
1173 + *
1174 + * @return string|null
1175 + */
1176 + protected function get_site_environment_type() {
1177 + if ( function_exists( 'get_blog_option' ) ) {
1178 + return get_blog_option( get_current_blog_id(), 'jetpack_callable_wp_get_environment_type', null );
1179 + }
1180 +
1181 + return get_option( 'jetpack_callable_wp_get_environment_type', null );
1182 + }
1000 1183 }
1001 1184
1002 1185 new WPCOM_JSON_API_List_Post_Formats_Endpoint(
1003 1186 array(
@@ -1023,9 +1206,11 @@
1023 1206 )
1024 1207 );
1025 1208
1026 1209 /**
1027 - * List Post Formates endpoint class.
1210 + * List Post Formats endpoint class.
1211 + *
1212 + * @phan-constructor-used-for-side-effects
1028 1213 */
1029 1214 class WPCOM_JSON_API_List_Post_Formats_Endpoint extends WPCOM_JSON_API_Endpoint { // phpcs:ignore
1030 1215 /**
1031 1216 *
@@ -1034,8 +1219,10 @@
1034 1219 * /sites/%s/post-formats -> $blog_id
1035 1220 *
1036 1221 * @param string $path - the path.
1037 1222 * @param int $blog_id - the blog ID.
1223 + *
1224 + * @return array|\WP_Error Array with 'formats' on success, or WP_Error on failure.
1038 1225 */
1039 1226 public function callback( $path = '', $blog_id = 0 ) {
1040 1227 $blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
1041 1228 if ( is_wp_error( $blog_id ) ) {
@@ -1089,8 +1276,10 @@
1089 1276 );
1090 1277
1091 1278 /**
1092 1279 * List page templates endpoint class.
1280 + *
1281 + * @phan-constructor-used-for-side-effects
1093 1282 */
1094 1283 class WPCOM_JSON_API_List_Page_Templates_Endpoint extends WPCOM_JSON_API_Endpoint { // phpcs:ignore
1095 1284 /**
1096 1285 *
@@ -1098,8 +1287,10 @@
1098 1287 * /sites/%s/page-templates -> $blog_id
1099 1288 *
1100 1289 * @param string $path - the path.
1101 1290 * @param int $blog_id - the blog ID.
1291 + *
1292 + * @return array|\WP_Error Array with 'templates' on success, or WP_Error on failure.
1102 1293 */
1103 1294 public function callback( $path = '', $blog_id = 0 ) {
1104 1295 $blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
1105 1296 if ( is_wp_error( $blog_id ) ) {