186 lines
14 KiB
PHP
186 lines
14 KiB
PHP
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
|
|
|
|
new WPCOM_JSON_API_Site_Settings_V1_4_Endpoint(
|
|
array(
|
|
'description' => 'Get detailed settings information about a site.',
|
|
'group' => '__do_not_document',
|
|
'stat' => 'sites:X',
|
|
'min_version' => '1.4',
|
|
'method' => 'GET',
|
|
'path' => '/sites/%s/settings',
|
|
'path_labels' => array(
|
|
'$site' => '(int|string) Site ID or domain',
|
|
),
|
|
|
|
'query_parameters' => array(
|
|
'context' => false,
|
|
),
|
|
|
|
'response_format' => WPCOM_JSON_API_Site_Settings_Endpoint::$site_format,
|
|
|
|
'example_request' => 'https://public-api.wordpress.com/rest/v1.4/sites/en.blog.wordpress.com/settings?pretty=1',
|
|
)
|
|
);
|
|
|
|
new WPCOM_JSON_API_Site_Settings_V1_4_Endpoint(
|
|
array(
|
|
'description' => 'Update settings for a site.',
|
|
'group' => '__do_not_document',
|
|
'stat' => 'sites:X',
|
|
'min_version' => '1.4',
|
|
'method' => 'POST',
|
|
'path' => '/sites/%s/settings',
|
|
'path_labels' => array(
|
|
'$site' => '(int|string) Site ID or domain',
|
|
),
|
|
|
|
'request_format' => array(
|
|
'migration_source_site_domain' => '(string) The source site URL, from the migration flow',
|
|
'in_site_migration_flow' => '(string) Whether the site is currently in the Site Migration signup flow.',
|
|
'blogname' => '(string) Blog name',
|
|
'blogdescription' => '(string) Blog description',
|
|
'default_pingback_flag' => '(bool) Notify blogs linked from article?',
|
|
'default_ping_status' => '(bool) Allow link notifications from other blogs?',
|
|
'default_comment_status' => '(bool) Allow comments on new articles?',
|
|
'blog_public' => '(string) Site visibility; -1: private, 0: discourage search engines, 1: allow search engines',
|
|
'wpcom_data_sharing_opt_out' => '(bool) Did the site opt out of public content sharing with third parties and research partners?',
|
|
'jetpack_sync_non_public_post_stati' => '(bool) allow sync of post and pages with non-public posts stati',
|
|
'jetpack_relatedposts_enabled' => '(bool) Enable related posts?',
|
|
'jetpack_relatedposts_show_context' => '(bool) Show post\'s tags and category in related posts?',
|
|
'jetpack_relatedposts_show_date' => '(bool) Show date in related posts?',
|
|
'jetpack_relatedposts_show_headline' => '(bool) Show headline in related posts?',
|
|
'jetpack_relatedposts_show_thumbnails' => '(bool) Show thumbnails in related posts?',
|
|
'instant_search_enabled' => '(bool) Enable the new Jetpack Instant Search interface',
|
|
'jetpack_search_enabled' => '(bool) Enable Jetpack Search',
|
|
'jetpack_search_supported' => '(bool) Jetpack Search supported',
|
|
'jetpack_protect_whitelist' => '(array) List of IP addresses to always allow',
|
|
'infinite_scroll' => '(bool) Support infinite scroll of posts?',
|
|
'default_category' => '(int) Default post category',
|
|
'default_post_format' => '(string) Default post format',
|
|
'require_name_email' => '(bool) Require comment authors to fill out name and email?',
|
|
'comment_registration' => '(bool) Require users to be registered and logged in to comment?',
|
|
'close_comments_for_old_posts' => '(bool) Automatically close comments on old posts?',
|
|
'close_comments_days_old' => '(int) Age at which to close comments',
|
|
'thread_comments' => '(bool) Enable threaded comments?',
|
|
'thread_comments_depth' => '(int) Depth to thread comments',
|
|
'page_comments' => '(bool) Break comments into pages?',
|
|
'comments_per_page' => '(int) Number of comments to display per page',
|
|
'default_comments_page' => '(string) newest|oldest Which page of comments to display first',
|
|
'comment_order' => '(string) asc|desc Order to display comments within page',
|
|
'comments_notify' => '(bool) Email me when someone comments?',
|
|
'moderation_notify' => '(bool) Email me when a comment is helf for moderation?',
|
|
'social_notifications_like' => '(bool) Email me when someone likes my post?',
|
|
'social_notifications_reblog' => '(bool) Email me when someone reblogs my post?',
|
|
'social_notifications_subscribe' => '(bool) Email me when someone subscribes to my blog?',
|
|
'comment_moderation' => '(bool) Moderate comments for manual approval?',
|
|
'comment_previously_approved' => '(bool) Moderate comments unless author has a previously-approved comment?',
|
|
'comment_max_links' => '(int) Moderate comments that contain X or more links',
|
|
'moderation_keys' => '(string) Words or phrases that trigger comment moderation, one per line',
|
|
'disallowed_keys' => '(string) Words or phrases that mark comment spam, one per line',
|
|
'lang_id' => '(int) ID for language blog is written in',
|
|
'locale' => '(string) locale code for language blog is written in',
|
|
'site_vertical_id' => '(string) The site vertical ID',
|
|
'wga' => '(array) Google Analytics Settings',
|
|
'jetpack_cloudflare_analytics' => '(array) Cloudflare Analytics Settings',
|
|
'disabled_likes' => '(bool) Are likes globally disabled (they can still be turned on per post)?',
|
|
'disabled_reblogs' => '(bool) Are reblogs disabled on posts?',
|
|
'jetpack_comment_likes_enabled' => '(bool) Are comment likes enabled for all comments?',
|
|
'sharing_button_style' => '(string) Style to use for sharing buttons (icon-text, icon, text, or official)',
|
|
'sharing_label' => '(string) Label to use for sharing buttons, e.g. "Share this:"',
|
|
'sharing_show' => '(string|array:string) Post type or array of types where sharing buttons are to be displayed',
|
|
'sharing_open_links' => '(string) Link target for sharing buttons (same or new)',
|
|
'twitter_via' => '(string) Twitter username to include in tweets when people share using the Twitter button',
|
|
'jetpack-twitter-cards-site-tag' => '(string) The Twitter username of the owner of the site\'s domain.',
|
|
'eventbrite_api_token' => '(int) The Keyring token ID for an Eventbrite token to associate with the site',
|
|
'timezone_string' => '(string) PHP-compatible timezone string like \'UTC-5\'',
|
|
'gmt_offset' => '(int) Site offset from UTC in hours',
|
|
'date_format' => '(string) PHP Date-compatible date format',
|
|
'time_format' => '(string) PHP Date-compatible time format',
|
|
'start_of_week' => '(int) Starting day of week (0 = Sunday, 6 = Saturday)',
|
|
'woocommerce_onboarding_profile' => '(array) woocommerce_onboarding_profile',
|
|
'woocommerce_store_address' => '(string) woocommerce_store_address option',
|
|
'woocommerce_store_address_2' => '(string) woocommerce_store_address_2 option',
|
|
'woocommerce_store_city' => '(string) woocommerce_store_city option',
|
|
'woocommerce_default_country' => '(string) woocommerce_default_country option',
|
|
'woocommerce_store_postcode' => '(string) woocommerce_store_postcode option',
|
|
'jetpack_testimonial' => '(bool) Whether testimonial custom post type is enabled for the site',
|
|
'jetpack_testimonial_posts_per_page' => '(int) Number of testimonials to show per page',
|
|
'jetpack_portfolio' => '(bool) Whether portfolio custom post type is enabled for the site',
|
|
'jetpack_portfolio_posts_per_page' => '(int) Number of portfolio projects to show per page',
|
|
Jetpack_SEO_Utils::FRONT_PAGE_META_OPTION => '(string) The SEO meta description for the site.',
|
|
Jetpack_SEO_Titles::TITLE_FORMATS_OPTION => '(array) SEO meta title formats. Allowed keys: front_page, posts, pages, groups, archives',
|
|
'verification_services_codes' => '(array) Website verification codes. Allowed keys: google, pinterest, bing, yandex, facebook',
|
|
'podcasting_archive' => '(string) The post category, if any, used for publishing podcasts',
|
|
'site_icon' => '(int) Media attachment ID to use as site icon. Set to zero or an otherwise empty value to clear',
|
|
'api_cache' => '(bool) Turn on/off the Jetpack JSON API cache',
|
|
'posts_per_page' => '(int) Number of posts to show on blog pages',
|
|
'posts_per_rss' => '(int) Number of posts to show in the RSS feed',
|
|
'rss_use_excerpt' => '(bool) Whether the RSS feed will use post excerpts',
|
|
'wpcom_publish_posts_with_markdown' => '(bool) Whether markdown is enabled for posts',
|
|
'wpcom_publish_comments_with_markdown' => '(bool) Whether markdown is enabled for comments',
|
|
'launchpad_screen' => '(string) Whether or not launchpad is presented and what size it will be',
|
|
'wpcom_featured_image_in_email' => '(bool) Whether the Featured image is displayed in the New Post email template or not',
|
|
'jetpack_gravatar_in_email' => '(bool) Whether to show author avatar in the email byline',
|
|
'jetpack_author_in_email' => '(bool) Whether to show author display name in the email byline',
|
|
'jetpack_post_date_in_email' => '(bool) Whether to show date in the email byline',
|
|
'wpcom_newsletter_categories' => '(array) Array of post category ids that are marked as newsletter categories',
|
|
'wpcom_newsletter_categories_enabled' => '(bool) Whether the newsletter categories are enabled or not',
|
|
'sm_enabled' => '(bool) Whether the newsletter Subscribe Modal is enabled or not',
|
|
'jetpack_subscribe_overlay_enabled' => '(bool) Whether the newsletter Subscribe Overlay is enabled or not',
|
|
'jetpack_subscribe_floating_button_enabled' => '(bool) Whether the newsletter floating subscribe button is enabled or not',
|
|
'jetpack_subscriptions_subscribe_post_end_enabled' => '(bool) Whether adding Subscribe block at the end of each post is enabled or not',
|
|
'jetpack_subscriptions_login_navigation_enabled' => '(bool) Whether the Subscriber Login block navigation placement is enabled or not',
|
|
'jetpack_subscriptions_subscribe_navigation_enabled' => '(bool) Whether the Subscribe block navigation placement is enabled or not',
|
|
'wpcom_gifting_subscription' => '(bool) Whether gifting is enabled for non auto-renew sites',
|
|
'wpcom_reader_views_enabled' => '(bool) Whether showing post views in WordPress.com Reader is enabled for the site',
|
|
'wpcom_subscription_emails_use_excerpt' => '(bool) Whether site subscription emails (e.g. New Post email notification) will use post excerpts',
|
|
'jetpack_subscriptions_reply_to' => '(string) The reply to email behaviour for newsletter emails',
|
|
'jetpack_subscriptions_from_name' => '(string) The from name for newsletter emails',
|
|
'show_on_front' => '(string) Whether homepage should display related posts or a static page. The expected value is \'posts\' or \'page\'.',
|
|
'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\'.',
|
|
'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\'.',
|
|
'subscription_options' => '(array) Array of three options used in subscription email templates: \'invitation\', \'welcome\' and \'comment_follow\' strings.',
|
|
'jetpack_verbum_subscription_modal' => '(bool) Whether Subscription modal is enabled in Verbum comments',
|
|
'wpcom_ai_site_prompt' => '(string) User input in the AI site prompt',
|
|
'enable_verbum_commenting' => '(bool) Whether Verbum commenting is enabled',
|
|
'enable_blocks_comments' => '(bool) Whether blocks comments are enabled',
|
|
'highlander_comment_form_prompt' => '(string) The prompt for the comment form',
|
|
'jetpack_comment_form_color_scheme' => '(string) The color scheme for the comment form',
|
|
'is_fully_managed_agency_site' => '(bool) Whether the site is a fully managed agency site',
|
|
'wpcom_hide_action_bar' => '(bool) Whether to hide the Action bar',
|
|
),
|
|
|
|
'response_format' => array(
|
|
'updated' => '(array)',
|
|
),
|
|
|
|
'example_request' => 'https://public-api.wordpress.com/rest/v1.4/sites/en.blog.wordpress.com/settings?pretty=1',
|
|
)
|
|
);
|
|
|
|
/**
|
|
* Settings v1_4 endpoint class.
|
|
*/
|
|
class WPCOM_JSON_API_Site_Settings_V1_4_Endpoint extends WPCOM_JSON_API_Site_Settings_V1_3_Endpoint {
|
|
|
|
/**
|
|
* Get the defaults.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function get_defaults() {
|
|
return array(
|
|
'code' => '',
|
|
'anonymize_ip' => false,
|
|
'honor_dnt' => false,
|
|
'ec_track_purchases' => false,
|
|
'ec_track_add_to_cart' => false,
|
|
'enh_ec_tracking' => false,
|
|
'enh_ec_track_remove_from_cart' => false,
|
|
'enh_ec_track_prod_impression' => false,
|
|
'enh_ec_track_prod_click' => false,
|
|
'enh_ec_track_prod_detail_view' => false,
|
|
'enh_ec_track_checkout_started' => false,
|
|
);
|
|
}
|
|
}
|