| 1 |
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 |
|
| 3 |
if ( ! defined( 'ABSPATH' ) ) { |
| 4 |
exit( 0 ); |
| 5 |
} |
| 6 |
|
| 7 |
new WPCOM_JSON_API_Site_Settings_V1_4_Endpoint( |
| 8 |
array( |
| 9 |
'description' => 'Get detailed settings information about a site.', |
| 10 |
'group' => '__do_not_document', |
| 11 |
'stat' => 'sites:X', |
| 12 |
'min_version' => '1.4', |
| 13 |
'method' => 'GET', |
| 14 |
'path' => '/sites/%s/settings', |
| 15 |
'path_labels' => array( |
| 16 |
'$site' => '(int|string) Site ID or domain', |
| 17 |
), |
| 18 |
|
| 19 |
'query_parameters' => array( |
| 20 |
'context' => false, |
| 21 |
), |
| 22 |
|
| 23 |
'response_format' => WPCOM_JSON_API_Site_Settings_Endpoint::$site_format, |
| 24 |
|
| 25 |
'example_request' => 'https://public-api.wordpress.com/rest/v1.4/sites/en.blog.wordpress.com/settings?pretty=1', |
| 26 |
) |
| 27 |
); |
| 28 |
|
| 29 |
new WPCOM_JSON_API_Site_Settings_V1_4_Endpoint( |
| 30 |
array( |
| 31 |
'description' => 'Update settings for a site.', |
| 32 |
'group' => '__do_not_document', |
| 33 |
'stat' => 'sites:X', |
| 34 |
'min_version' => '1.4', |
| 35 |
'method' => 'POST', |
| 36 |
'path' => '/sites/%s/settings', |
| 37 |
'path_labels' => array( |
| 38 |
'$site' => '(int|string) Site ID or domain', |
| 39 |
), |
| 40 |
|
| 41 |
'request_format' => array( |
| 42 |
'migration_source_site_domain' => '(string) The source site URL, from the migration flow', |
| 43 |
'in_site_migration_flow' => '(string) Whether the site is currently in the Site Migration signup flow.', |
| 44 |
'blogname' => '(string) Blog name', |
| 45 |
'blogdescription' => '(string) Blog description', |
| 46 |
'default_pingback_flag' => '(bool) Notify blogs linked from article?', |
| 47 |
'default_ping_status' => '(bool) Allow link notifications from other blogs?', |
| 48 |
'default_comment_status' => '(bool) Allow comments on new articles?', |
| 49 |
'blog_public' => '(string) Site visibility; -1: private, 0: discourage search engines, 1: allow search engines', |
| 50 |
'wpcom_data_sharing_opt_out' => '(bool) Did the site opt out of public content sharing with third parties and research partners?', |
| 51 |
'jetpack_sync_non_public_post_stati' => '(bool) allow sync of post and pages with non-public posts stati', |
| 52 |
'jetpack_relatedposts_enabled' => '(bool) Enable related posts?', |
| 53 |
'jetpack_relatedposts_show_context' => '(bool) Show post\'s tags and category in related posts?', |
| 54 |
'jetpack_relatedposts_show_date' => '(bool) Show date in related posts?', |
| 55 |
'jetpack_relatedposts_show_headline' => '(bool) Show headline in related posts?', |
| 56 |
'jetpack_relatedposts_show_thumbnails' => '(bool) Show thumbnails in related posts?', |
| 57 |
'instant_search_enabled' => '(bool) Enable the new Jetpack Instant Search interface', |
| 58 |
'jetpack_search_enabled' => '(bool) Enable Jetpack Search', |
| 59 |
'jetpack_search_supported' => '(bool) Jetpack Search supported', |
| 60 |
'jetpack_protect_whitelist' => '(array) List of IP addresses to always allow', |
| 61 |
'infinite_scroll' => '(bool) Support infinite scroll of posts?', |
| 62 |
'default_category' => '(int) Default post category', |
| 63 |
'default_post_format' => '(string) Default post format', |
| 64 |
'require_name_email' => '(bool) Require comment authors to fill out name and email?', |
| 65 |
'comment_registration' => '(bool) Require users to be registered and logged in to comment?', |
| 66 |
'close_comments_for_old_posts' => '(bool) Automatically close comments on old posts?', |
| 67 |
'close_comments_days_old' => '(int) Age at which to close comments', |
| 68 |
'thread_comments' => '(bool) Enable threaded comments?', |
| 69 |
'thread_comments_depth' => '(int) Depth to thread comments', |
| 70 |
'page_comments' => '(bool) Break comments into pages?', |
| 71 |
'comments_per_page' => '(int) Number of comments to display per page', |
| 72 |
'default_comments_page' => '(string) newest|oldest Which page of comments to display first', |
| 73 |
'comment_order' => '(string) asc|desc Order to display comments within page', |
| 74 |
'comments_notify' => '(bool) Email me when someone comments?', |
| 75 |
'moderation_notify' => '(bool) Email me when a comment is helf for moderation?', |
| 76 |
'social_notifications_like' => '(bool) Email me when someone likes my post?', |
| 77 |
'social_notifications_reblog' => '(bool) Email me when someone reblogs my post?', |
| 78 |
'social_notifications_subscribe' => '(bool) Email me when someone subscribes to my blog?', |
| 79 |
'comment_moderation' => '(bool) Moderate comments for manual approval?', |
| 80 |
'comment_previously_approved' => '(bool) Moderate comments unless author has a previously-approved comment?', |
| 81 |
'comment_max_links' => '(int) Moderate comments that contain X or more links', |
| 82 |
'moderation_keys' => '(string) Words or phrases that trigger comment moderation, one per line', |
| 83 |
'disallowed_keys' => '(string) Words or phrases that mark comment spam, one per line', |
| 84 |
'lang_id' => '(int) ID for language blog is written in', |
| 85 |
'locale' => '(string) locale code for language blog is written in', |
| 86 |
'site_vertical_id' => '(string) The site vertical ID', |
| 87 |
'wga' => '(array) Google Analytics Settings', |
| 88 |
'jetpack_cloudflare_analytics' => '(array) Cloudflare Analytics Settings', |
| 89 |
'disabled_likes' => '(bool) Are likes globally disabled (they can still be turned on per post)?', |
| 90 |
'disabled_reblogs' => '(bool) Are reblogs disabled on posts?', |
| 91 |
'jetpack_comment_likes_enabled' => '(bool) Are comment likes enabled for all comments?', |
| 92 |
'sharing_button_style' => '(string) Style to use for sharing buttons (icon-text, icon, text, or official)', |
| 93 |
'sharing_label' => '(string) Label to use for sharing buttons, e.g. "Share this:"', |
| 94 |
'sharing_show' => '(string|array:string) Post type or array of types where sharing buttons are to be displayed', |
| 95 |
'sharing_open_links' => '(string) Link target for sharing buttons (same or new)', |
| 96 |
'twitter_via' => '(string) Twitter username to include in tweets when people share using the Twitter button', |
| 97 |
'jetpack-twitter-cards-site-tag' => '(string) The Twitter username of the owner of the site\'s domain.', |
| 98 |
'eventbrite_api_token' => '(int) The Keyring token ID for an Eventbrite token to associate with the site', |
| 99 |
'timezone_string' => '(string) PHP-compatible timezone string like \'UTC-5\'', |
| 100 |
'gmt_offset' => '(int) Site offset from UTC in hours', |
| 101 |
'date_format' => '(string) PHP Date-compatible date format', |
| 102 |
'time_format' => '(string) PHP Date-compatible time format', |
| 103 |
'start_of_week' => '(int) Starting day of week (0 = Sunday, 6 = Saturday)', |
| 104 |
'woocommerce_onboarding_profile' => '(array) woocommerce_onboarding_profile', |
| 105 |
'woocommerce_store_address' => '(string) woocommerce_store_address option', |
| 106 |
'woocommerce_store_address_2' => '(string) woocommerce_store_address_2 option', |
| 107 |
'woocommerce_store_city' => '(string) woocommerce_store_city option', |
| 108 |
'woocommerce_default_country' => '(string) woocommerce_default_country option', |
| 109 |
'woocommerce_store_postcode' => '(string) woocommerce_store_postcode option', |
| 110 |
'jetpack_testimonial' => '(bool) Whether testimonial custom post type is enabled for the site', |
| 111 |
'jetpack_testimonial_posts_per_page' => '(int) Number of testimonials to show per page', |
| 112 |
'jetpack_portfolio' => '(bool) Whether portfolio custom post type is enabled for the site', |
| 113 |
'jetpack_portfolio_posts_per_page' => '(int) Number of portfolio projects to show per page', |
| 114 |
Jetpack_SEO_Utils::FRONT_PAGE_META_OPTION => '(string) The SEO meta description for the site.', |
| 115 |
Jetpack_SEO_Titles::TITLE_FORMATS_OPTION => '(array) SEO meta title formats. Allowed keys: front_page, posts, pages, groups, archives', |
| 116 |
'verification_services_codes' => '(array) Website verification codes. Allowed keys: google, pinterest, bing, yandex, facebook', |
| 117 |
'podcasting_archive' => '(string) The post category, if any, used for publishing podcasts', |
| 118 |
'site_icon' => '(int) Media attachment ID to use as site icon. Set to zero or an otherwise empty value to clear', |
| 119 |
'api_cache' => '(bool) Turn on/off the Jetpack JSON API cache', |
| 120 |
'posts_per_page' => '(int) Number of posts to show on blog pages', |
| 121 |
'posts_per_rss' => '(int) Number of posts to show in the RSS feed', |
| 122 |
'rss_use_excerpt' => '(bool) Whether the RSS feed will use post excerpts', |
| 123 |
'wpcom_publish_posts_with_markdown' => '(bool) Whether markdown is enabled for posts', |
| 124 |
'wpcom_publish_comments_with_markdown' => '(bool) Whether markdown is enabled for comments', |
| 125 |
'launchpad_screen' => '(string) Whether or not launchpad is presented and what size it will be', |
| 126 |
'wpcom_newsletter_send_default' => '(bool) Whether to send newsletter emails by default when publishing a post', |
| 127 |
'wpcom_featured_image_in_email' => '(bool) Whether the Featured image is displayed in the New Post email template or not', |
| 128 |
'jetpack_gravatar_in_email' => '(bool) Whether to show author avatar in the email byline', |
| 129 |
'jetpack_author_in_email' => '(bool) Whether to show author display name in the email byline', |
| 130 |
'jetpack_post_date_in_email' => '(bool) Whether to show date in the email byline', |
| 131 |
'wpcom_newsletter_categories' => '(array) Array of post category ids that are marked as newsletter categories', |
| 132 |
'wpcom_newsletter_categories_enabled' => '(bool) Whether the newsletter categories are enabled or not', |
| 133 |
'newsletter_has_active_plan' => '(bool) Whether there is an active newsletter plan for the site', |
| 134 |
'sm_enabled' => '(bool) Whether the newsletter Subscribe Modal is enabled or not', |
| 135 |
'jetpack_subscribe_overlay_enabled' => '(bool) Whether the newsletter Subscribe Overlay is enabled or not', |
| 136 |
'jetpack_subscribe_floating_button_enabled' => '(bool) Whether the newsletter floating subscribe button is enabled or not', |
| 137 |
'jetpack_subscriptions_subscribe_post_end_enabled' => '(bool) Whether adding Subscribe block at the end of each post is enabled or not', |
| 138 |
'jetpack_subscriptions_login_navigation_enabled' => '(bool) Whether the Subscriber Login block navigation placement is enabled or not', |
| 139 |
'jetpack_subscriptions_subscribe_navigation_enabled' => '(bool) Whether the Subscribe block navigation placement is enabled or not', |
| 140 |
'wpcom_gifting_subscription' => '(bool) Whether gifting is enabled for non auto-renew sites', |
| 141 |
'wpcom_reader_views_enabled' => '(bool) Whether showing post views in WordPress.com Reader is enabled for the site', |
| 142 |
'wpcom_subscription_emails_use_excerpt' => '(bool) Whether site subscription emails (e.g. New Post email notification) will use post excerpts', |
| 143 |
'jetpack_subscriptions_reply_to' => '(string) The reply to email behaviour for newsletter emails', |
| 144 |
'jetpack_subscriptions_from_name' => '(string) The from name for newsletter emails', |
| 145 |
'show_on_front' => '(string) Whether homepage should display related posts or a static page. The expected value is \'posts\' or \'page\'.', |
| 146 |
'page_on_front' => '(string) The page ID of the page to use as the site\'s homepage. It will apply only if \'show_on_front\' is set to \'page\'.', |
| 147 |
'page_for_posts' => '(string) The page ID of the page to use as the site\'s posts page. It will apply only if \'show_on_front\' is set to \'page\'.', |
| 148 |
'subscription_options' => '(array) Array of options used in subscription email templates and the Subscribe block: \'invitation\', \'welcome\', \'comment_follow\' and \'subscribe_modal_heading\' strings.', |
| 149 |
'jetpack_verbum_subscription_modal' => '(bool) Whether Subscription modal is enabled in Verbum comments', |
| 150 |
'wpcom_ai_site_prompt' => '(string) User input in the AI site prompt', |
| 151 |
'enable_verbum_commenting' => '(bool) Whether Verbum commenting is enabled', |
| 152 |
'enable_blocks_comments' => '(bool) Whether blocks comments are enabled', |
| 153 |
'highlander_comment_form_prompt' => '(string) The prompt for the comment form', |
| 154 |
'jetpack_comment_form_color_scheme' => '(string) The color scheme for the comment form', |
| 155 |
'is_fully_managed_agency_site' => '(bool) Whether the site is a fully managed agency site', |
| 156 |
'wpcom_hide_action_bar' => '(bool) Whether to hide the Action bar', |
| 157 |
'mcp_abilities' => '(array) List of MCP Abilities', |
| 158 |
), |
| 159 |
|
| 160 |
'response_format' => array( |
| 161 |
'updated' => '(array)', |
| 162 |
), |
| 163 |
|
| 164 |
'example_request' => 'https://public-api.wordpress.com/rest/v1.4/sites/en.blog.wordpress.com/settings?pretty=1', |
| 165 |
) |
| 166 |
); |
| 167 |
|
| 168 |
/** |
| 169 |
* Settings v1_4 endpoint class. |
| 170 |
* |
| 171 |
* @phan-constructor-used-for-side-effects |
| 172 |
*/ |
| 173 |
class WPCOM_JSON_API_Site_Settings_V1_4_Endpoint extends WPCOM_JSON_API_Site_Settings_V1_3_Endpoint { |
| 174 |
|
| 175 |
/** |
| 176 |
* Get the defaults. |
| 177 |
* |
| 178 |
* @return array |
| 179 |
*/ |
| 180 |
protected function get_defaults() { |
| 181 |
return array( |
| 182 |
'code' => '', |
| 183 |
'anonymize_ip' => false, |
| 184 |
'honor_dnt' => false, |
| 185 |
'ec_track_purchases' => false, |
| 186 |
'ec_track_add_to_cart' => false, |
| 187 |
'enh_ec_tracking' => false, |
| 188 |
'enh_ec_track_remove_from_cart' => false, |
| 189 |
'enh_ec_track_prod_impression' => false, |
| 190 |
'enh_ec_track_prod_click' => false, |
| 191 |
'enh_ec_track_prod_detail_view' => false, |
| 192 |
'enh_ec_track_checkout_started' => false, |
| 193 |
); |
| 194 |
} |
| 195 |
} |
| 196 |
|
