← All changes
|
json-endpoints/class.wpcom-json-api-get-site-endpoint.php
+269
-45
12.3.2
→
16.3-beta
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. |
| @@ -78,8 +87,24 @@ | ||
| 78 | 87 | 'is_wpcom_atomic' => '(bool) If the site is a WP.com Atomic one.', |
| 79 | 88 | 'is_wpcom_staging_site' => '(bool) If the site is a WP.com staging site.', |
| 80 | 89 | 'user_interactions' => '(array) An array of user interactions with a site.', |
| 81 | 90 | 'was_ecommerce_trial' => '(bool) If the site ever used an eCommerce trial.', |
| 91 | + 'was_upgraded_from_trial' => '(bool) If the site ever upgraded to a paid plan from a trial.', | |
| 92 | + 'was_migration_trial' => '(bool) If the site ever used a migration trial.', | |
| 93 | + 'was_hosting_trial' => '(bool) If the site ever used a hosting trial.', | |
| 94 | + 'wpcom_site_setup' => '(string) The WP.com site setup identifier.', | |
| 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.', | |
| 82 | 107 | ); |
| 83 | 108 | |
| 84 | 109 | /** |
| 85 | 110 | * No member fields. |
| @@ -111,8 +136,15 @@ | ||
| 111 | 136 | 'is_fse_eligible', |
| 112 | 137 | 'is_core_site_editor_enabled', |
| 113 | 138 | 'is_wpcom_atomic', |
| 114 | 139 | 'is_wpcom_staging_site', |
| 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', | |
| 115 | 147 | ); |
| 116 | 148 | |
| 117 | 149 | /** |
| 118 | 150 | * Site options. |
| @@ -131,8 +163,9 @@ | ||
| 131 | 163 | 'is_redirect', |
| 132 | 164 | 'unmapped_url', |
| 133 | 165 | 'featured_images_enabled', |
| 134 | 166 | 'theme_slug', |
| 167 | + 'theme_errors', | |
| 135 | 168 | 'header_image', |
| 136 | 169 | 'background_color', |
| 137 | 170 | 'image_default_link_type', |
| 138 | 171 | 'image_thumbnail_width', |
| @@ -192,40 +225,58 @@ | ||
| 192 | 225 | 'was_created_with_blank_canvas_design', |
| 193 | 226 | 'videopress_storage_used', |
| 194 | 227 | 'is_difm_lite_in_progress', |
| 195 | 228 | 'difm_lite_site_options', |
| 229 | + 'is_gating_business_q1', | |
| 230 | + 'is_legacy_gating_site', | |
| 196 | 231 | 'site_intent', |
| 232 | + 'site_partner_bundle', | |
| 233 | + 'onboarding_segment', | |
| 197 | 234 | 'site_vertical_id', |
| 198 | 235 | 'blogging_prompts_settings', |
| 199 | 236 | 'launchpad_screen', |
| 200 | 237 | 'launchpad_checklist_tasks_statuses', |
| 238 | + 'migration_source_site_domain', | |
| 201 | 239 | 'wpcom_production_blog_id', |
| 202 | 240 | 'wpcom_staging_blog_ids', |
| 203 | 241 | 'can_blaze', |
| 242 | + 'wpcom_site_setup', | |
| 243 | + 'is_commercial', | |
| 244 | + 'is_commercial_reasons', | |
| 245 | + 'wpcom_admin_interface', | |
| 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', | |
| 253 | + 'wpcom_ai_launchpad_no_guidance', | |
| 204 | 254 | ); |
| 205 | 255 | |
| 206 | 256 | /** |
| 207 | - * List of DIFM Lite options to be displayed | |
| 208 | - * | |
| 209 | - * @var array $displayed_difm_lite_site_options | |
| 210 | - */ | |
| 211 | - protected static $displayed_difm_lite_site_options = array( | |
| 212 | - 'site_category', | |
| 213 | - 'is_website_content_submitted', | |
| 214 | - 'selected_page_titles', | |
| 215 | - ); | |
| 216 | - | |
| 217 | - /** | |
| 218 | 257 | * Jetpack response fields. |
| 219 | 258 | * |
| 220 | 259 | * @var array $jetpack_response_field_additions |
| 221 | 260 | */ |
| 222 | 261 | protected static $jetpack_response_field_additions = array( |
| 262 | + 'slug', | |
| 223 | 263 | 'subscribers_count', |
| 224 | 264 | 'site_migration', |
| 225 | 265 | 'site_owner', |
| 226 | 266 | 'is_wpcom_staging_site', |
| 227 | 267 | 'was_ecommerce_trial', |
| 268 | + 'was_migration_trial', | |
| 269 | + 'was_hosting_trial', | |
| 270 | + 'was_upgraded_from_trial', | |
| 271 | + 'is_a4a_dev_site', | |
| 272 | + 'is_garden', | |
| 273 | + 'garden_name', | |
| 274 | + 'garden_partner', | |
| 275 | + 'garden_is_provisioned', | |
| 276 | + 'is_wpcom_flex', | |
| 277 | + 'big_sky_enabled', | |
| 278 | + 'atomic_email_block', | |
| 228 | 279 | ); |
| 229 | 280 | |
| 230 | 281 | /** |
| 231 | 282 | * Jetpack response field member additions. |
| @@ -241,9 +292,9 @@ | ||
| 241 | 292 | |
| 242 | 293 | /** |
| 243 | 294 | * Jetpack response option additions. |
| 244 | 295 | * |
| 245 | - * @var array $jetpack_response_field_member_additions | |
| 296 | + * @var array $jetpack_response_option_additions | |
| 246 | 297 | */ |
| 247 | 298 | protected static $jetpack_response_option_additions = array( |
| 248 | 299 | 'publicize_permanently_disabled', |
| 249 | 300 | 'ak_vp_bundle_enabled', |
| @@ -266,15 +317,33 @@ | ||
| 266 | 317 | 'videopress_storage_used', |
| 267 | 318 | 'blogging_prompts_settings', |
| 268 | 319 | 'wpcom_production_blog_id', |
| 269 | 320 | 'wpcom_staging_blog_ids', |
| 321 | + 'is_commercial', | |
| 322 | + 'is_commercial_reasons', | |
| 323 | + 'wpcom_admin_interface', | |
| 324 | + 'wpcom_classic_early_release', | |
| 325 | + 'jetpack_recovery_mode_status', | |
| 326 | + 'jetpack_sso_require_two_step', | |
| 327 | + 'apm_enabled', | |
| 270 | 328 | ); |
| 271 | 329 | |
| 272 | 330 | /** |
| 273 | - * Site | |
| 331 | + * Current enabled trials. | |
| 274 | 332 | * |
| 275 | - * @var $site. | |
| 333 | + * @var array $jetpack_enabled_trials | |
| 276 | 334 | */ |
| 335 | + public static $jetpack_enabled_trials = array( | |
| 336 | + 'was_ecommerce_trial' => 'ecommerce', | |
| 337 | + 'was_migration_trial' => 'migration', | |
| 338 | + 'was_hosting_trial' => 'hosting', | |
| 339 | + ); | |
| 340 | + | |
| 341 | + /** | |
| 342 | + * Site. | |
| 343 | + * | |
| 344 | + * @var SAL_Site $site. | |
| 345 | + */ | |
| 277 | 346 | private $site; |
| 278 | 347 | |
| 279 | 348 | /** |
| 280 | 349 | * Fields to include. |
| @@ -296,10 +365,12 @@ | ||
| 296 | 365 | * |
| 297 | 366 | * /sites/mine |
| 298 | 367 | * /sites/%s -> $blog_id\ |
| 299 | 368 | * |
| 300 | - * @param string $path - the path. | |
| 301 | - * @param int $blog_id - the blog ID. | |
| 369 | + * @param string $path - the path. | |
| 370 | + * @param int|string $blog_id - the blog ID or the string 'mine'. | |
| 371 | + * | |
| 372 | + * @return array|\WP_Error Site response array on success, or WP_Error on failure. | |
| 302 | 373 | */ |
| 303 | 374 | public function callback( $path = '', $blog_id = 0 ) { |
| 304 | 375 | if ( 'mine' === $blog_id ) { |
| 305 | 376 | $api = WPCOM_JSON_API::init(); |
| @@ -435,8 +506,11 @@ | ||
| 435 | 506 | switch ( $key ) { |
| 436 | 507 | case 'ID': |
| 437 | 508 | $response[ $key ] = $this->site->blog_id; |
| 438 | 509 | break; |
| 510 | + case 'slug': | |
| 511 | + $response[ $key ] = $this->site->get_slug(); | |
| 512 | + break; | |
| 439 | 513 | case 'name': |
| 440 | 514 | $response[ $key ] = $this->site->get_name(); |
| 441 | 515 | break; |
| 442 | 516 | case 'description': |
| @@ -542,13 +616,9 @@ | ||
| 542 | 616 | case 'products': |
| 543 | 617 | $response[ $key ] = $this->site->get_products(); |
| 544 | 618 | break; |
| 545 | 619 | case 'zendesk_site_meta': |
| 546 | - // D59613-code only added this function to the wpcom SAL subclasses. Absent any better idea, | |
| 547 | - // we'll just omit the key entirely in Jetpack. | |
| 548 | - if ( is_callable( array( $this->site, 'get_zendesk_site_meta' ) ) ) { | |
| 549 | - $response[ $key ] = $this->site->get_zendesk_site_meta(); | |
| 550 | - } | |
| 620 | + $response[ $key ] = $this->site->get_zendesk_site_meta(); | |
| 551 | 621 | break; |
| 552 | 622 | case 'quota': |
| 553 | 623 | $response[ $key ] = $this->site->get_quota(); |
| 554 | 624 | break; |
| @@ -576,10 +646,65 @@ | ||
| 576 | 646 | case 'p2_thumbnail_elements': |
| 577 | 647 | $response[ $key ] = $this->site->get_p2_thumbnail_elements(); |
| 578 | 648 | break; |
| 579 | 649 | case 'was_ecommerce_trial': |
| 580 | - $response[ $key ] = $this->site->was_ecommerce_trial(); | |
| 650 | + $response[ $key ] = $this->site->was_trial( self::$jetpack_enabled_trials['was_ecommerce_trial'] ); | |
| 581 | 651 | break; |
| 652 | + case 'was_migration_trial': | |
| 653 | + $response[ $key ] = $this->site->was_trial( self::$jetpack_enabled_trials['was_migration_trial'] ); | |
| 654 | + break; | |
| 655 | + case 'was_hosting_trial': | |
| 656 | + $response[ $key ] = $this->site->was_trial( self::$jetpack_enabled_trials['was_hosting_trial'] ); | |
| 657 | + break; | |
| 658 | + case 'was_upgraded_from_trial': | |
| 659 | + $response[ $key ] = $this->site->was_upgraded_from_trial(); | |
| 660 | + break; | |
| 661 | + case 'is_deleted': | |
| 662 | + $response[ $key ] = $this->site->is_deleted(); | |
| 663 | + break; | |
| 664 | + case 'is_a4a_client': | |
| 665 | + $response[ $key ] = $this->site->is_a4a_client(); | |
| 666 | + break; | |
| 667 | + case 'is_a4a_dev_site': | |
| 668 | + $response[ $key ] = $this->site->is_a4a_dev_site(); | |
| 669 | + break; | |
| 670 | + case 'is_garden': | |
| 671 | + $response[ $key ] = $this->site->is_garden(); | |
| 672 | + break; | |
| 673 | + case 'garden_name': | |
| 674 | + $response[ $key ] = $this->site->garden_name(); | |
| 675 | + break; | |
| 676 | + case 'garden_partner': | |
| 677 | + $response[ $key ] = $this->site->garden_partner(); | |
| 678 | + break; | |
| 679 | + case 'garden_is_provisioned': | |
| 680 | + $response[ $key ] = $this->site->garden_is_provisioned(); | |
| 681 | + break; | |
| 682 | + case 'is_wpcom_flex': | |
| 683 | + $response[ $key ] = $this->site->is_wpcom_flex(); | |
| 684 | + break; | |
| 685 | + case 'big_sky_enabled': | |
| 686 | + $response[ $key ] = $this->site->is_big_sky_enabled(); | |
| 687 | + break; | |
| 688 | + case 'atomic_email_block': | |
| 689 | + $response[ $key ] = $this->site->get_atomic_email_block(); | |
| 690 | + break; | |
| 691 | + case 'hosting_provider_guess': | |
| 692 | + // WordPress.com platform decoration, computed only when explicitly requested | |
| 693 | + // via `fields` so default `_all` responses are unchanged. | |
| 694 | + if ( $this->is_wpcom() | |
| 695 | + && function_exists( 'get_jetpack_hosting_provider' ) | |
| 696 | + && is_array( $this->fields_to_include ) ) { | |
| 697 | + $response[ $key ] = get_jetpack_hosting_provider( get_current_blog_id() ); | |
| 698 | + } | |
| 699 | + break; | |
| 700 | + case 'environment_type': | |
| 701 | + // WordPress.com platform decoration, computed only when explicitly requested | |
| 702 | + // via `fields` so default `_all` responses are unchanged. | |
| 703 | + if ( $this->is_wpcom() && is_array( $this->fields_to_include ) ) { | |
| 704 | + $response[ $key ] = $this->get_site_environment_type(); | |
| 705 | + } | |
| 706 | + break; | |
| 582 | 707 | } |
| 583 | 708 | |
| 584 | 709 | do_action( 'post_render_site_response_key', $key ); |
| 585 | 710 | } |
| @@ -629,8 +754,11 @@ | ||
| 629 | 754 | break; |
| 630 | 755 | case 'theme_slug': |
| 631 | 756 | $options[ $key ] = $site->get_theme_slug(); |
| 632 | 757 | break; |
| 758 | + case 'theme_errors': | |
| 759 | + $options[ $key ] = $site->get_theme_errors(); | |
| 760 | + break; | |
| 633 | 761 | case 'header_image': |
| 634 | 762 | $options[ $key ] = $site->get_header_image(); |
| 635 | 763 | break; |
| 636 | 764 | case 'background_color': |
| @@ -789,13 +917,9 @@ | ||
| 789 | 917 | case 'import_engine': |
| 790 | 918 | $options[ $key ] = $site->get_import_engine(); |
| 791 | 919 | break; |
| 792 | 920 | case 'is_pending_plan': |
| 793 | - // D40032-code only added this function to the wpcom SAL subclasses. Absent any better idea, | |
| 794 | - // we'll just omit the key entirely in Jetpack. | |
| 795 | - if ( is_callable( array( $site, 'is_pending_plan' ) ) ) { | |
| 796 | - $options[ $key ] = $site->is_pending_plan(); | |
| 797 | - } | |
| 921 | + $options[ $key ] = $site->is_pending_plan(); | |
| 798 | 922 | break; |
| 799 | 923 | |
| 800 | 924 | case 'is_wpforteams_site': |
| 801 | 925 | $options[ $key ] = $site->is_wpforteams_site(); |
| @@ -837,25 +961,31 @@ | ||
| 837 | 961 | case 'is_difm_lite_in_progress': |
| 838 | 962 | $options[ $key ] = $site->is_difm_lite_in_progress(); |
| 839 | 963 | break; |
| 840 | 964 | case 'difm_lite_site_options': |
| 841 | - $difm_lite_options = $site->get_difm_lite_site_options(); | |
| 842 | - $visible_options = self::$displayed_difm_lite_site_options; | |
| 843 | - $filtered_difm_lite_options = new stdClass(); | |
| 844 | - if ( $difm_lite_options ) { | |
| 845 | - $filtered_difm_lite_options = array_filter( | |
| 846 | - $difm_lite_options, | |
| 847 | - function ( $key ) use ( $visible_options ) { | |
| 848 | - return in_array( $key, $visible_options, true ); | |
| 849 | - }, | |
| 850 | - ARRAY_FILTER_USE_KEY | |
| 851 | - ); | |
| 965 | + $difm_lite_site_options = $site->get_difm_lite_site_options(); | |
| 966 | + if ( null !== $difm_lite_site_options ) { | |
| 967 | + $options[ $key ] = (object) $difm_lite_site_options; | |
| 852 | 968 | } |
| 853 | - $options[ $key ] = $filtered_difm_lite_options; | |
| 854 | 969 | break; |
| 970 | + case 'is_gating_business_q1': | |
| 971 | + $options[ $key ] = $site->is_gating_business_q1(); | |
| 972 | + break; | |
| 973 | + case 'is_legacy_gating_site': | |
| 974 | + $options[ $key ] = $site->is_legacy_gating_site(); | |
| 975 | + break; | |
| 855 | 976 | case 'site_intent': |
| 856 | 977 | $options[ $key ] = $site->get_site_intent(); |
| 857 | 978 | break; |
| 979 | + case 'site_partner_bundle': | |
| 980 | + $options[ $key ] = $site->get_site_partner_bundle(); | |
| 981 | + break; | |
| 982 | + case 'site_goals': | |
| 983 | + $options[ $key ] = $site->get_site_goals(); | |
| 984 | + break; | |
| 985 | + case 'onboarding_segment': | |
| 986 | + $options[ $key ] = $site->get_onboarding_segment(); | |
| 987 | + break; | |
| 858 | 988 | case 'site_vertical_id': |
| 859 | 989 | $options[ $key ] = $site->get_site_vertical_id(); |
| 860 | 990 | break; |
| 861 | 991 | case 'blogging_prompts_settings': |
| @@ -868,8 +998,11 @@ | ||
| 868 | 998 | break; |
| 869 | 999 | case 'launchpad_checklist_tasks_statuses': |
| 870 | 1000 | $options[ $key ] = $site->get_launchpad_checklist_tasks_statuses(); |
| 871 | 1001 | break; |
| 1002 | + case 'migration_source_site_domain': | |
| 1003 | + $options[ $key ] = $site->get_migration_source_site_domain(); | |
| 1004 | + break; | |
| 872 | 1005 | case 'wpcom_production_blog_id': |
| 873 | 1006 | $options[ $key ] = $site->get_wpcom_production_blog_id(); |
| 874 | 1007 | break; |
| 875 | 1008 | case 'wpcom_staging_blog_ids': |
| @@ -877,8 +1010,44 @@ | ||
| 877 | 1010 | break; |
| 878 | 1011 | case 'can_blaze': |
| 879 | 1012 | $options[ $key ] = $site->can_blaze(); |
| 880 | 1013 | break; |
| 1014 | + case 'wpcom_site_setup': | |
| 1015 | + $options[ $key ] = $site->get_wpcom_site_setup(); | |
| 1016 | + break; | |
| 1017 | + case 'is_commercial': | |
| 1018 | + $options[ $key ] = $site->is_commercial(); | |
| 1019 | + break; | |
| 1020 | + case 'is_commercial_reasons': | |
| 1021 | + $options[ $key ] = $site->get_is_commercial_reasons(); | |
| 1022 | + break; | |
| 1023 | + case 'wpcom_admin_interface': | |
| 1024 | + $options[ $key ] = $site->get_wpcom_admin_interface(); | |
| 1025 | + break; | |
| 1026 | + case 'wpcom_classic_early_release': | |
| 1027 | + $options[ $key ] = $site->get_wpcom_classic_early_release(); | |
| 1028 | + break; | |
| 1029 | + case 'jetpack_recovery_mode_status': | |
| 1030 | + $options[ $key ] = $site->get_jetpack_recovery_mode_status(); | |
| 1031 | + break; | |
| 1032 | + case 'jetpack_sso_require_two_step': | |
| 1033 | + $options[ $key ] = $site->get_jetpack_sso_require_two_step(); | |
| 1034 | + break; | |
| 1035 | + case 'apm_enabled': | |
| 1036 | + $options[ $key ] = $site->get_apm_enabled(); | |
| 1037 | + break; | |
| 1038 | + case 'wpcom_ai_launchpad_enabled': | |
| 1039 | + $options[ $key ] = $site->is_ai_launchpad_enabled(); | |
| 1040 | + break; | |
| 1041 | + case 'wpcom_ai_launchpad_dismissed': | |
| 1042 | + $options[ $key ] = $site->is_ai_launchpad_dismissed(); | |
| 1043 | + break; | |
| 1044 | + case 'wpcom_ai_launchpad_completed': | |
| 1045 | + $options[ $key ] = $site->is_ai_launchpad_completed(); | |
| 1046 | + break; | |
| 1047 | + case 'wpcom_ai_launchpad_no_guidance': | |
| 1048 | + $options[ $key ] = $site->is_ai_launchpad_no_guidance(); | |
| 1049 | + break; | |
| 881 | 1050 | } |
| 882 | 1051 | } |
| 883 | 1052 | |
| 884 | 1053 | return $options; |
| @@ -910,14 +1079,20 @@ | ||
| 910 | 1079 | |
| 911 | 1080 | /** |
| 912 | 1081 | * Apply any WPCOM-only response components to a Jetpack site response. |
| 913 | 1082 | * |
| 914 | - * @param array $response - the response. | |
| 1083 | + * @param object $response - the response. | |
| 915 | 1084 | */ |
| 916 | 1085 | public function decorate_jetpack_response( &$response ) { |
| 1086 | + $this->filter_fields_and_options(); | |
| 917 | 1087 | $this->site = $this->get_platform()->get_site( $response->ID ); |
| 918 | 1088 | switch_to_blog( $this->site->get_id() ); |
| 919 | 1089 | |
| 1090 | + // Allow the SAL site to apply its own overrides to the proxied response. | |
| 1091 | + if ( method_exists( $this->site, 'decorate_jetpack_response' ) ) { | |
| 1092 | + $this->site->decorate_jetpack_response( $response ); // @phan-suppress-current-line PhanUndeclaredMethod -- checked via method_exists(). | |
| 1093 | + } | |
| 1094 | + | |
| 920 | 1095 | $wpcom_response = $this->render_response_keys( self::$jetpack_response_field_additions ); |
| 921 | 1096 | |
| 922 | 1097 | foreach ( $wpcom_response as $key => $value ) { |
| 923 | 1098 | $response->{ $key } = $value; |
| @@ -922,9 +1097,11 @@ | ||
| 922 | 1097 | foreach ( $wpcom_response as $key => $value ) { |
| 923 | 1098 | $response->{ $key } = $value; |
| 924 | 1099 | } |
| 925 | 1100 | |
| 926 | - if ( $this->has_user_access() || $this->has_blog_access( $this->api->token_details ) ) { | |
| 1101 | + $has_site_access = $this->has_user_access() || $this->has_blog_access( $this->api->token_details ); | |
| 1102 | + | |
| 1103 | + if ( $has_site_access ) { | |
| 927 | 1104 | $wpcom_member_response = $this->render_response_keys( self::$jetpack_response_field_member_additions ); |
| 928 | 1105 | |
| 929 | 1106 | foreach ( $wpcom_member_response as $key => $value ) { |
| 930 | 1107 | $response->{ $key } = $value; |
| @@ -943,22 +1120,28 @@ | ||
| 943 | 1120 | unset( $response->site_owner ); |
| 944 | 1121 | unset( $response->plan ); |
| 945 | 1122 | unset( $response->products ); |
| 946 | 1123 | unset( $response->zendesk_site_meta ); |
| 1124 | + unset( $response->atomic_email_block ); | |
| 947 | 1125 | } |
| 948 | 1126 | |
| 949 | 1127 | // render additional options. |
| 950 | - if ( $response->options ) { | |
| 1128 | + if ( isset( $response->options ) && $response->options ) { | |
| 951 | 1129 | $wpcom_options_response = $this->render_option_keys( self::$jetpack_response_option_additions ); |
| 952 | 1130 | |
| 953 | 1131 | // Remove heic from jetpack (and atomic) sites so that the iOS app know to convert the file format into a JPEG. |
| 954 | 1132 | // heic fromat is currently not supported by for uploading. |
| 955 | 1133 | // See https://jetpackp2.wordpress.com/2020/08/19/image-uploads-in-the-wp-ios-app-broken |
| 956 | - if ( $this->site->is_jetpack() && isset( $response->options['allowed_file_types'] ) ) { | |
| 1134 | + if ( | |
| 1135 | + $this->site->is_jetpack() | |
| 1136 | + && isset( $response->options['allowed_file_types'] ) | |
| 1137 | + && is_array( $response->options['allowed_file_types'] ) | |
| 1138 | + ) { | |
| 1139 | + $allowed_file_types = (array) $response->options['allowed_file_types']; | |
| 957 | 1140 | $remove_file_types = array( |
| 958 | 1141 | 'heic', |
| 959 | 1142 | ); |
| 960 | - $response->options['allowed_file_types'] = array_values( array_diff( $response->options['allowed_file_types'], $remove_file_types ) ); | |
| 1143 | + $response->options['allowed_file_types'] = array_values( array_diff( $allowed_file_types, $remove_file_types ) ); | |
| 961 | 1144 | } |
| 962 | 1145 | |
| 963 | 1146 | foreach ( $wpcom_options_response as $key => $value ) { |
| 964 | 1147 | $response->options[ $key ] = $value; |
| @@ -964,11 +1147,44 @@ | ||
| 964 | 1147 | $response->options[ $key ] = $value; |
| 965 | 1148 | } |
| 966 | 1149 | } |
| 967 | 1150 | |
| 1151 | + // WordPress.com platform fields are not part of proxied Jetpack responses; | |
| 1152 | + // add them only when explicitly requested. | |
| 1153 | + if ( $this->is_wpcom() && $has_site_access && is_array( $this->fields_to_include ) ) { | |
| 1154 | + if ( function_exists( 'get_jetpack_hosting_provider' ) && in_array( 'hosting_provider_guess', $this->fields_to_include, true ) ) { | |
| 1155 | + $response->hosting_provider_guess = get_jetpack_hosting_provider( get_current_blog_id() ); | |
| 1156 | + } | |
| 1157 | + if ( in_array( 'environment_type', $this->fields_to_include, true ) ) { | |
| 1158 | + $response->environment_type = $this->get_site_environment_type(); | |
| 1159 | + } | |
| 1160 | + } | |
| 1161 | + | |
| 968 | 1162 | restore_current_blog(); |
| 969 | 1163 | return $response; // possibly no need since it's modified in place. |
| 970 | 1164 | } |
| 1165 | + | |
| 1166 | + /** | |
| 1167 | + * Whether this request is running on the WordPress.com platform. | |
| 1168 | + * | |
| 1169 | + * @return bool | |
| 1170 | + */ | |
| 1171 | + protected function is_wpcom() { | |
| 1172 | + return ( new \Automattic\Jetpack\Status\Host() )->is_wpcom_platform(); | |
| 1173 | + } | |
| 1174 | + | |
| 1175 | + /** | |
| 1176 | + * Get the site's synced WP_ENVIRONMENT_TYPE. | |
| 1177 | + * | |
| 1178 | + * @return string|null | |
| 1179 | + */ | |
| 1180 | + protected function get_site_environment_type() { | |
| 1181 | + if ( function_exists( 'get_blog_option' ) ) { | |
| 1182 | + return get_blog_option( get_current_blog_id(), 'jetpack_callable_wp_get_environment_type', null ); | |
| 1183 | + } | |
| 1184 | + | |
| 1185 | + return get_option( 'jetpack_callable_wp_get_environment_type', null ); | |
| 1186 | + } | |
| 971 | 1187 | } |
| 972 | 1188 | |
| 973 | 1189 | new WPCOM_JSON_API_List_Post_Formats_Endpoint( |
| 974 | 1190 | array( |
| @@ -994,9 +1210,11 @@ | ||
| 994 | 1210 | ) |
| 995 | 1211 | ); |
| 996 | 1212 | |
| 997 | 1213 | /** |
| 998 | - * List Post Formates endpoint class. | |
| 1214 | + * List Post Formats endpoint class. | |
| 1215 | + * | |
| 1216 | + * @phan-constructor-used-for-side-effects | |
| 999 | 1217 | */ |
| 1000 | 1218 | class WPCOM_JSON_API_List_Post_Formats_Endpoint extends WPCOM_JSON_API_Endpoint { // phpcs:ignore |
| 1001 | 1219 | /** |
| 1002 | 1220 | * |
| @@ -1005,8 +1223,10 @@ | ||
| 1005 | 1223 | * /sites/%s/post-formats -> $blog_id |
| 1006 | 1224 | * |
| 1007 | 1225 | * @param string $path - the path. |
| 1008 | 1226 | * @param int $blog_id - the blog ID. |
| 1227 | + * | |
| 1228 | + * @return array|\WP_Error Array with 'formats' on success, or WP_Error on failure. | |
| 1009 | 1229 | */ |
| 1010 | 1230 | public function callback( $path = '', $blog_id = 0 ) { |
| 1011 | 1231 | $blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) ); |
| 1012 | 1232 | if ( is_wp_error( $blog_id ) ) { |
| @@ -1060,8 +1280,10 @@ | ||
| 1060 | 1280 | ); |
| 1061 | 1281 | |
| 1062 | 1282 | /** |
| 1063 | 1283 | * List page templates endpoint class. |
| 1284 | + * | |
| 1285 | + * @phan-constructor-used-for-side-effects | |
| 1064 | 1286 | */ |
| 1065 | 1287 | class WPCOM_JSON_API_List_Page_Templates_Endpoint extends WPCOM_JSON_API_Endpoint { // phpcs:ignore |
| 1066 | 1288 | /** |
| 1067 | 1289 | * |
| @@ -1069,8 +1291,10 @@ | ||
| 1069 | 1291 | * /sites/%s/page-templates -> $blog_id |
| 1070 | 1292 | * |
| 1071 | 1293 | * @param string $path - the path. |
| 1072 | 1294 | * @param int $blog_id - the blog ID. |
| 1295 | + * | |
| 1296 | + * @return array|\WP_Error Array with 'templates' on success, or WP_Error on failure. | |
| 1073 | 1297 | */ |
| 1074 | 1298 | public function callback( $path = '', $blog_id = 0 ) { |
| 1075 | 1299 | $blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) ); |
| 1076 | 1300 | if ( is_wp_error( $blog_id ) ) { |