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

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

jetpack / json-endpoints Last commit date

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

215 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	new WPCOM_JSON_API_Site_Settings_V1_2_Endpoint(
4	array(
5	'description' => 'Get detailed settings information about a site.',
6	'group' => '__do_not_document',
7	'stat' => 'sites:X',
8	'min_version' => '1.2',
9	'method' => 'GET',
10	'path' => '/sites/%s/settings',
11	'path_labels' => array(
12	'$site' => '(int\|string) Site ID or domain',
13	),
14
15	'query_parameters' => array(
16	'context' => false,
17	),
18
19	'response_format' => WPCOM_JSON_API_Site_Settings_Endpoint::$site_format,
20
21	'example_request' => 'https://public-api.wordpress.com/rest/v1.2/sites/en.blog.wordpress.com/settings?pretty=1',
22	)
23	);
24
25	new WPCOM_JSON_API_Site_Settings_V1_2_Endpoint(
26	array(
27	'description' => 'Update settings for a site.',
28	'group' => '__do_not_document',
29	'stat' => 'sites:X',
30	'min_version' => '1.2',
31	'method' => 'POST',
32	'path' => '/sites/%s/settings',
33	'path_labels' => array(
34	'$site' => '(int\|string) Site ID or domain',
35	),
36
37	'request_format' => array(
38	'blogname' => '(string) Blog name',
39	'blogdescription' => '(string) Blog description',
40	'default_pingback_flag' => '(bool) Notify blogs linked from article?',
41	'default_ping_status' => '(bool) Allow link notifications from other blogs?',
42	'default_comment_status' => '(bool) Allow comments on new articles?',
43	'blog_public' => '(string) Site visibility; -1: private, 0: discourage search engines, 1: allow search engines',
44	'jetpack_sync_non_public_post_stati' => '(bool) allow sync of post and pages with non-public posts stati',
45	'jetpack_relatedposts_enabled' => '(bool) Enable related posts?',
46	'jetpack_relatedposts_show_context' => '(bool) Show post\'s tags and category in related posts?',
47	'jetpack_relatedposts_show_date' => '(bool) Show date in related posts?',
48	'jetpack_relatedposts_show_headline' => '(bool) Show headline in related posts?',
49	'jetpack_relatedposts_show_thumbnails' => '(bool) Show thumbnails in related posts?',
50	'instant_search_enabled' => '(bool) Enable the new Jetpack Instant Search interface',
51	'jetpack_search_enabled' => '(bool) Enable Jetpack Search',
52	'jetpack_search_supported' => '(bool) Jetpack Search supported',
53	'jetpack_protect_whitelist' => '(array) List of IP addresses to always allow',
54	'infinite_scroll' => '(bool) Support infinite scroll of posts?',
55	'default_category' => '(int) Default post category',
56	'default_post_format' => '(string) Default post format',
57	'require_name_email' => '(bool) Require comment authors to fill out name and email?',
58	'comment_registration' => '(bool) Require users to be registered and logged in to comment?',
59	'close_comments_for_old_posts' => '(bool) Automatically close comments on old posts?',
60	'close_comments_days_old' => '(int) Age at which to close comments',
61	'thread_comments' => '(bool) Enable threaded comments?',
62	'thread_comments_depth' => '(int) Depth to thread comments',
63	'page_comments' => '(bool) Break comments into pages?',
64	'comments_per_page' => '(int) Number of comments to display per page',
65	'default_comments_page' => '(string) newest\|oldest Which page of comments to display first',
66	'comment_order' => '(string) asc\|desc Order to display comments within page',
67	'comments_notify' => '(bool) Email me when someone comments?',
68	'moderation_notify' => '(bool) Email me when a comment is helf for moderation?',
69	'social_notifications_like' => '(bool) Email me when someone likes my post?',
70	'social_notifications_reblog' => '(bool) Email me when someone reblogs my post?',
71	'social_notifications_subscribe' => '(bool) Email me when someone subscribes to my blog?',
72	'comment_moderation' => '(bool) Moderate comments for manual approval?',
73	'comment_previously_approved' => '(bool) Moderate comments unless author has a previously-approved comment?',
74	'comment_max_links' => '(int) Moderate comments that contain X or more links',
75	'moderation_keys' => '(string) Words or phrases that trigger comment moderation, one per line',
76	'disallowed_keys' => '(string) Words or phrases that mark comment spam, one per line',
77	'lang_id' => '(int) ID for language blog is written in',
78	'locale' => '(string) locale code for language blog is written in',
79	'wga' => '(array) Google Analytics Settings',
80	'disabled_likes' => '(bool) Are likes globally disabled (they can still be turned on per post)?',
81	'disabled_reblogs' => '(bool) Are reblogs disabled on posts?',
82	'jetpack_comment_likes_enabled' => '(bool) Are comment likes enabled for all comments?',
83	'sharing_button_style' => '(string) Style to use for sharing buttons (icon-text, icon, text, or official)',
84	'sharing_label' => '(string) Label to use for sharing buttons, e.g. "Share this:"',
85	'sharing_show' => '(string\|array:string) Post type or array of types where sharing buttons are to be displayed',
86	'sharing_open_links' => '(string) Link target for sharing buttons (same or new)',
87	'twitter_via' => '(string) Twitter username to include in tweets when people share using the Twitter button',
88	'jetpack-twitter-cards-site-tag' => '(string) The Twitter username of the owner of the site\'s domain.',
89	'eventbrite_api_token' => '(int) The Keyring token ID for an Eventbrite token to associate with the site',
90	'timezone_string' => '(string) PHP-compatible timezone string like \'UTC-5\'',
91	'gmt_offset' => '(int) Site offset from UTC in hours',
92	'date_format' => '(string) PHP Date-compatible date format',
93	'time_format' => '(string) PHP Date-compatible time format',
94	'start_of_week' => '(int) Starting day of week (0 = Sunday, 6 = Saturday)',
95	'jetpack_testimonial' => '(bool) Whether testimonial custom post type is enabled for the site',
96	'jetpack_testimonial_posts_per_page' => '(int) Number of testimonials to show per page',
97	'jetpack_portfolio' => '(bool) Whether portfolio custom post type is enabled for the site',
98	'jetpack_portfolio_posts_per_page' => '(int) Number of portfolio projects to show per page',
99	Jetpack_SEO_Utils::FRONT_PAGE_META_OPTION => '(string) The SEO meta description for the site.',
100	Jetpack_SEO_Titles::TITLE_FORMATS_OPTION => '(array) SEO meta title formats. Allowed keys: front_page, posts, pages, groups, archives',
101	'verification_services_codes' => '(array) Website verification codes. Allowed keys: google, pinterest, bing, yandex, facebook',
102	'podcasting_archive' => '(string) The post category, if any, used for publishing podcasts',
103	'site_icon' => '(int) Media attachment ID to use as site icon. Set to zero or an otherwise empty value to clear',
104	'api_cache' => '(bool) Turn on/off the Jetpack JSON API cache',
105	'posts_per_page' => '(int) Number of posts to show on blog pages',
106	'posts_per_rss' => '(int) Number of posts to show in the RSS feed',
107	'rss_use_excerpt' => '(bool) Whether the RSS feed will use post excerpts',
108	'wpcom_publish_posts_with_markdown' => '(bool) Whether markdown is enabled for posts',
109	'wpcom_publish_comments_with_markdown' => '(bool) Whether markdown is enabled for comments',
110	),
111
112	'response_format' => array(
113	'updated' => '(array)',
114	),
115
116	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/settings?pretty=1',
117	)
118	);
119
120	/**
121	* Site settings v1_2 endpoint.
122	*/
123	class WPCOM_JSON_API_Site_Settings_V1_2_Endpoint extends WPCOM_JSON_API_Site_Settings_Endpoint {
124
125	/**
126	* Site format.
127	*
128	* @var array
129	*/
130	public static $site_format = array(
131	'ID' => '(int) Site ID',
132	'name' => '(string) Title of site',
133	'description' => '(string) Tagline or description of site',
134	'URL' => '(string) Full URL to the site',
135	'locale' => '(string) Locale code of the site',
136	'locale_variant' => '(string) Locale variant code for the site, if set',
137	'settings' => '(array) An array of options/settings for the blog. Only viewable by users with post editing rights to the site.',
138	);
139
140	/**
141	* API Callback.
142	*
143	* @param string $path - the path.
144	* @param int $blog_id - the blog ID.
145	*
146	* @return array\|WP_Error
147	*/
148	public function callback( $path = '', $blog_id = 0 ) {
149	add_filter( 'site_settings_endpoint_update_locale', array( $this, 'update_locale' ) );
150	add_filter( 'site_settings_endpoint_get', array( $this, 'return_locale' ) );
151	add_filter( 'site_settings_site_format', array( $this, 'site_format' ) );
152	return parent::callback( $path, $blog_id );
153	}
154
155	/**
156	* Get the locale.
157	*
158	* @param string $key - the key.
159	*
160	* @return string\|false
161	*/
162	protected function get_locale( $key ) {
163	if ( 'locale' === $key ) {
164	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
165	return (string) get_blog_lang_code();
166	} else {
167	return get_locale();
168	}
169	}
170
171	return false;
172	}
173
174	/**
175	* Return the locale.
176	*
177	* @param array $settings - the site settings.
178	*
179	* @return array `$settings` with a locale key added.
180	*/
181	public function return_locale( $settings ) {
182	return $settings + array( 'locale' => $this->get_locale( 'locale' ) );
183	}
184
185	/**
186	* Update the locale.
187	*
188	* @param string $value - the locale code.
189	*
190	* @return bool
191	*/
192	public function update_locale( $value ) {
193	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
194	$lang_id = get_lang_id_by_code( $value );
195	if ( ! empty( $lang_id ) ) {
196	if ( update_option( 'lang_id', $lang_id ) ) {
197	return true;
198	}
199	}
200	}
201	return false;
202	}
203
204	/**
205	* Format the site.
206	*
207	* @param string $format - the format.
208	*
209	* @return array
210	*/
211	public function site_format( $format ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
212	return self::$site_format;
213	}
214	}
215