class.wpcom-json-api-add-widget-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 14.2.2

jetpack / json-endpoints / class.wpcom-json-api-add-widget-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-add-widget-endpoint.php

148 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Activate a widget on a site.
4	*
5	* Endpoint: https://public-api.wordpress.com/rest/v1.1/sites/$site/widgets/new
6	*/
7
8	new WPCOM_JSON_API_Add_Widgets_Endpoint(
9	array(
10	'description' => 'Activate a group of widgets on a site. The bulk version of using the /new endpoint',
11	'group' => '__do_not_document',
12	'stat' => 'widgets:new:bulk',
13	'force' => 'wpcom',
14	'method' => 'POST',
15	'min_version' => '1.1',
16	'path' => '/sites/%s/widgets',
17	'path_labels' => array(
18	'$site' => '(string) Site ID or domain.',
19	),
20	'request_format' => array(
21	'widgets' => '(array:widget) An array of widget objects to add.',
22	),
23	'response_format' => array(
24	'widgets' => '(array:widget) An array of widget objects added.',
25	),
26	'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/12345678/widgets',
27	'example_request_data' => array(
28	'headers' => array(
29	'authorization' => 'Bearer YOUR_API_TOKEN',
30	),
31	'body' => array(
32	'id_base' => 'text',
33	'sidebar' => 'sidebar-2',
34	'position' => '0',
35	'settings' => array( 'title' => 'hello world' ),
36	),
37	),
38	'example_response' => '
39	{
40	"id": "text-3",
41	"id_base": "text",
42	"settings": {
43	"title": "hello world"
44	},
45	"sidebar": "sidebar-2",
46	"position": 0
47	}',
48	)
49	);
50
51	new WPCOM_JSON_API_Add_Widgets_Endpoint(
52	array(
53	'description' => 'Activate a widget on a site.',
54	'group' => 'sites',
55	'stat' => 'widgets:new',
56	'method' => 'POST',
57	'min_version' => '1.1',
58	'path' => '/sites/%s/widgets/new',
59	'path_labels' => array(
60	'$site' => '(string) Site ID or domain.',
61	),
62	'request_format' => array(
63	'id_base' => '(string) The base ID of the widget.',
64	'sidebar' => '(string) Optional. The ID of the sidebar where this widget will be active. If empty, the widget will be added in the first sidebar available.',
65	'position' => '(int) Optional. The position of the widget in the sidebar.',
66	'settings' => '(object) Optional. The settings for the new widget.',
67	),
68	'response_format' => array(
69	'id' => '(string) The actual ID of the widget.',
70	'sidebar' => '(string) The ID of the sidebar where this widget will be active.',
71	'position' => '(int) The final position of the widget in the sidebar.',
72	'settings' => '(array) The settings for the new widget.',
73	),
74	'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/12345678/widgets/new',
75	'example_request_data' => array(
76	'headers' => array(
77	'authorization' => 'Bearer YOUR_API_TOKEN',
78	),
79	'body' => array(
80	'id_base' => 'text',
81	'sidebar' => 'sidebar-2',
82	'position' => '0',
83	'settings' => array( 'title' => 'hello world' ),
84	),
85	),
86	'example_response' => '
87	{
88	"id": "text-3",
89	"id_base": "text",
90	"settings": {
91	"title": "hello world"
92	},
93	"sidebar": "sidebar-2",
94	"position": 0
95	}',
96	)
97	);
98
99	/**
100	* The Add Widgets endpoint class.
101	*/
102	class WPCOM_JSON_API_Add_Widgets_Endpoint extends WPCOM_JSON_API_Endpoint {
103	/**
104	* API callback.
105	*
106	* @param string $path - the path.
107	* @param int $blog_id - the blog ID.
108	* @uses Jetpack_Widgets
109	*
110	* @return array\|WP_Error
111	*/
112	public function callback( $path = '', $blog_id = 0 ) {
113	// Switch to the given blog.
114	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
115	if ( is_wp_error( $blog_id ) ) {
116	return $blog_id;
117	}
118
119	if ( ! current_user_can( 'edit_theme_options' ) ) {
120	return new WP_Error( 'unauthorized', 'User is not authorized to access widgets', 403 );
121	}
122
123	require_once JETPACK__PLUGIN_DIR . '_inc/lib/widgets.php';
124	$args = $this->input( false, false ); // Don't filter the input.
125	if ( empty( $args ) \|\| ! is_array( $args ) ) {
126	return new WP_Error( 'no_data', 'No data was provided.', 400 );
127	}
128	if ( isset( $args['widgets'] ) \|\| ! empty( $args['widgets'] ) ) {
129	$widgets = Jetpack_Widgets::activate_widgets( $args['widgets'] );
130	if ( is_wp_error( $widgets ) ) {
131	return $widgets;
132	}
133	return array( 'widgets' => $widgets );
134	}
135	if ( ! isset( $args['id_base'] ) ) {
136	return new WP_Error( 'missing_data', 'The data you provided was not accurate.', 400 );
137	}
138
139	if ( empty( $args['sidebar'] ) ) {
140	$active_sidebars = Jetpack_Widgets::get_active_sidebars();
141	reset( $active_sidebars );
142	$args['sidebar'] = key( $active_sidebars );
143	}
144
145	return Jetpack_Widgets::activate_widget( $args['id_base'], $args['sidebar'], $args['position'], $args['settings'] );
146	}
147	}
148