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

jetpack / json-endpoints / class.wpcom-json-api-update-taxonomy-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-update-taxonomy-endpoint.php

384 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Update site taxonomy API endpoints.
4	*
5	* Endpoints:
6	* Create a new category: /sites/%s/categories/new
7	* Create a new tag: /sites/%s/tags/new
8	* Edit a category: /sites/%s/categories/slug:%s
9	* Edit a tag: /sites/%s/tags/slug:%s
10	* Delete a category: /sites/%s/categories/slug:%s/delete
11	* Delete a tag: /sites/%s/tags/slug:%s/delete
12	*/
13
14	new WPCOM_JSON_API_Update_Taxonomy_Endpoint(
15	array(
16	'description' => 'Create a new category.',
17	'group' => 'taxonomy',
18	'stat' => 'categories:new',
19
20	'method' => 'POST',
21	'path' => '/sites/%s/categories/new',
22	'path_labels' => array(
23	'$site' => '(int\|string) Site ID or domain',
24	),
25
26	'request_format' => array(
27	'name' => '(string) Name of the category',
28	'description' => '(string) A description of the category',
29	'parent' => '(int) ID of the parent category',
30	),
31
32	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/categories/new/',
33	'example_request_data' => array(
34	'headers' => array(
35	'authorization' => 'Bearer YOUR_API_TOKEN',
36	),
37	'body' => array(
38	'name' => 'Puppies',
39	),
40	),
41	)
42	);
43
44	new WPCOM_JSON_API_Update_Taxonomy_Endpoint(
45	array(
46	'description' => 'Create a new tag.',
47	'group' => 'taxonomy',
48	'stat' => 'tags:new',
49
50	'method' => 'POST',
51	'path' => '/sites/%s/tags/new',
52	'path_labels' => array(
53	'$site' => '(int\|string) Site ID or domain',
54	),
55
56	'request_format' => array(
57	'name' => '(string) Name of the tag',
58	'description' => '(string) A description of the tag',
59	),
60
61	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/tags/new/',
62	'example_request_data' => array(
63	'headers' => array(
64	'authorization' => 'Bearer YOUR_API_TOKEN',
65	),
66	'body' => array(
67	'name' => 'Kitties',
68	),
69	),
70	)
71	);
72
73	new WPCOM_JSON_API_Update_Taxonomy_Endpoint(
74	array(
75	'description' => 'Edit a tag.',
76	'group' => 'taxonomy',
77	'stat' => 'tags:1:POST',
78
79	'method' => 'POST',
80	'path' => '/sites/%s/tags/slug:%s',
81	'path_labels' => array(
82	'$site' => '(int\|string) Site ID or domain',
83	'$tag' => '(string) The tag slug',
84	),
85
86	'request_format' => array(
87	'name' => '(string) Name of the tag',
88	'description' => '(string) A description of the tag',
89	),
90
91	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/tags/slug:testing-tag',
92	'example_request_data' => array(
93	'headers' => array(
94	'authorization' => 'Bearer YOUR_API_TOKEN',
95	),
96	'body' => array(
97	'description' => 'Kitties are awesome!',
98	),
99	),
100	)
101	);
102
103	new WPCOM_JSON_API_Update_Taxonomy_Endpoint(
104	array(
105	'description' => 'Edit a category.',
106	'group' => 'taxonomy',
107	'stat' => 'categories:1:POST',
108
109	'method' => 'POST',
110	'path' => '/sites/%s/categories/slug:%s',
111	'path_labels' => array(
112	'$site' => '(int\|string) Site ID or domain',
113	'$category' => '(string) The category slug',
114	),
115
116	'request_format' => array(
117	'name' => '(string) Name of the category',
118	'description' => '(string) A description of the category',
119	'parent' => '(int) ID of the parent category',
120	),
121
122	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/categories/slug:testing-category',
123	'example_request_data' => array(
124	'headers' => array(
125	'authorization' => 'Bearer YOUR_API_TOKEN',
126	),
127	'body' => array(
128	'description' => 'Puppies are great!',
129	),
130	),
131	)
132	);
133
134	new WPCOM_JSON_API_Update_Taxonomy_Endpoint(
135	array(
136	'description' => 'Delete a category.',
137	'group' => 'taxonomy',
138	'stat' => 'categories:1:delete',
139
140	'method' => 'POST',
141	'path' => '/sites/%s/categories/slug:%s/delete',
142	'path_labels' => array(
143	'$site' => '(int\|string) Site ID or domain',
144	'$category' => '(string) The category slug',
145	),
146	'response_format' => array(
147	'slug' => '(string) The slug of the deleted category',
148	'success' => '(bool) Was the operation successful?',
149	),
150
151	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/categories/slug:$category/delete',
152	'example_request_data' => array(
153	'headers' => array(
154	'authorization' => 'Bearer YOUR_API_TOKEN',
155	),
156	),
157	)
158	);
159
160	new WPCOM_JSON_API_Update_Taxonomy_Endpoint(
161	array(
162	'description' => 'Delete a tag.',
163	'group' => 'taxonomy',
164	'stat' => 'tags:1:delete',
165
166	'method' => 'POST',
167	'path' => '/sites/%s/tags/slug:%s/delete',
168	'path_labels' => array(
169	'$site' => '(int\|string) Site ID or domain',
170	'$tag' => '(string) The tag slug',
171	),
172	'response_format' => array(
173	'slug' => '(string) The slug of the deleted tag',
174	'success' => '(bool) Was the operation successful?',
175	),
176
177	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/tags/slug:$tag/delete',
178	'example_request_data' => array(
179	'headers' => array(
180	'authorization' => 'Bearer YOUR_API_TOKEN',
181	),
182	),
183	)
184	);
185
186	/**
187	* Update site taxonomy API class.
188	*/
189	class WPCOM_JSON_API_Update_Taxonomy_Endpoint extends WPCOM_JSON_API_Taxonomy_Endpoint {
190	/**
191	* Update site taxonomy API callback.
192	*
193	* - /sites/%s/tags\|categories/new -> $blog_id
194	* - /sites/%s/tags\|categories/slug:%s -> $blog_id, $taxonomy_id
195	* - /sites/%s/tags\|categories/slug:%s/delete -> $blog_id, $taxonomy_id
196	*
197	* @param string $path API path.
198	* @param int $blog_id Blog ID.
199	* @param int\|string $object_id Term.
200	*/
201	public function callback( $path = '', $blog_id = 0, $object_id = 0 ) {
202	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
203	if ( is_wp_error( $blog_id ) ) {
204	return $blog_id;
205	}
206
207	if ( preg_match( '#/tags/#i', $path ) ) {
208	$taxonomy_type = 'post_tag';
209	} else {
210	$taxonomy_type = 'category';
211	}
212
213	if ( $this->api->ends_with( $path, '/delete' ) ) {
214	return $this->delete_taxonomy( $path, $blog_id, $object_id, $taxonomy_type );
215	} elseif ( $this->api->ends_with( $path, '/new' ) ) {
216	return $this->new_taxonomy( $path, $blog_id, $taxonomy_type );
217	}
218
219	return $this->update_taxonomy( $path, $blog_id, $object_id, $taxonomy_type );
220	}
221
222	/**
223	* Create a new taxonomy.
224	*
225	* - /sites/%s/tags\|categories/new -> $blog_id
226	*
227	* @param string $path API path.
228	* @param int $blog_id Blog ID.
229	* @param string $taxonomy_type Taxonomy type (category, post_tag).
230	*/
231	public function new_taxonomy( $path, $blog_id, $taxonomy_type ) {
232	$args = $this->query_args();
233	$input = $this->input();
234	if ( ! is_array( $input ) \|\| ! $input \|\| ! strlen( $input['name'] ) ) {
235	return new WP_Error( 'invalid_input', 'Unknown data passed', 400 );
236	}
237
238	$user = wp_get_current_user();
239	if ( ! $user \|\| is_wp_error( $user ) \|\| ! $user->ID ) {
240	return new WP_Error( 'authorization_required', 'An active access token must be used to manage taxonomies.', 403 );
241	}
242
243	$tax = get_taxonomy( $taxonomy_type );
244	if ( ! current_user_can( $tax->cap->edit_terms ) ) {
245	return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
246	}
247
248	if ( 'category' !== $taxonomy_type \|\| ! isset( $input['parent'] ) ) {
249	$input['parent'] = 0;
250	}
251
252	$term = get_term_by( 'name', $input['name'], $taxonomy_type );
253	if ( $term ) {
254	// the same name is allowed as long as the parents are different.
255	if ( $input['parent'] === $term->parent ) {
256	return new WP_Error( 'duplicate', 'A taxonomy with that name already exists', 400 );
257	}
258	}
259
260	$data = wp_insert_term(
261	addslashes( $input['name'] ),
262	$taxonomy_type,
263	array(
264	'description' => isset( $input['description'] ) ? addslashes( $input['description'] ) : '',
265	'parent' => $input['parent'],
266	)
267	);
268
269	if ( is_wp_error( $data ) ) {
270	return $data;
271	}
272
273	$taxonomy = get_term_by( 'id', $data['term_id'], $taxonomy_type );
274
275	$return = $this->get_taxonomy( $taxonomy->slug, $taxonomy_type, $args['context'] );
276	if ( ! $return \|\| is_wp_error( $return ) ) {
277	return $return;
278	}
279
280	/** This action is documented in json-endpoints/class.wpcom-json-api-site-settings-endpoint.php */
281	do_action( 'wpcom_json_api_objects', 'taxonomies' );
282	return $return;
283	}
284
285	/**
286	* Update a taxonomy.
287	*
288	* - /sites/%s/tags\|categories/slug:%s -> $blog_id, $taxonomy_id
289	*
290	* @param string $path API path.
291	* @param int $blog_id Blog ID.
292	* @param int\|string $object_id Term.
293	* @param string $taxonomy_type Taxonomy type (category, post_tag).
294	*/
295	public function update_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) {
296	$taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type );
297	$tax = get_taxonomy( $taxonomy_type );
298	if ( ! current_user_can( $tax->cap->edit_terms ) ) {
299	return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
300	}
301
302	if ( ! $taxonomy \|\| is_wp_error( $taxonomy ) ) {
303	return new WP_Error( 'unknown_taxonomy', 'Unknown taxonomy', 404 );
304	}
305
306	if ( false === term_exists( $object_id, $taxonomy_type ) ) {
307	return new WP_Error( 'unknown_taxonomy', 'That taxonomy does not exist', 404 );
308	}
309
310	$args = $this->query_args();
311	$input = $this->input( false );
312	if ( ! is_array( $input ) \|\| ! $input ) {
313	return new WP_Error( 'invalid_input', 'Invalid request input', 400 );
314	}
315
316	$update = array();
317	if ( 'category' === $taxonomy_type && ! empty( $input['parent'] ) ) {
318	$update['parent'] = $input['parent'];
319	}
320
321	if ( ! empty( $input['description'] ) ) {
322	$update['description'] = addslashes( $input['description'] );
323	}
324
325	if ( ! empty( $input['name'] ) ) {
326	$update['name'] = addslashes( $input['name'] );
327	}
328
329	$data = wp_update_term( $taxonomy->term_id, $taxonomy_type, $update );
330	$taxonomy = get_term_by( 'id', $data['term_id'], $taxonomy_type );
331
332	$return = $this->get_taxonomy( $taxonomy->slug, $taxonomy_type, $args['context'] );
333	if ( ! $return \|\| is_wp_error( $return ) ) {
334	return $return;
335	}
336
337	/** This action is documented in json-endpoints/class.wpcom-json-api-site-settings-endpoint.php */
338	do_action( 'wpcom_json_api_objects', 'taxonomies' );
339	return $return;
340	}
341
342	/**
343	* Delete a taxonomy.
344	*
345	* - /sites/%s/tags\|categories/%s/delete -> $blog_id, $taxonomy_id
346	*
347	* @param string $path API path.
348	* @param int $blog_id Blog ID.
349	* @param int\|string $object_id Term.
350	* @param string $taxonomy_type Taxonomy type (category, post_tag).
351	*/
352	public function delete_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) {
353	$taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type );
354	$tax = get_taxonomy( $taxonomy_type );
355	if ( ! current_user_can( $tax->cap->delete_terms ) ) {
356	return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
357	}
358
359	if ( ! $taxonomy \|\| is_wp_error( $taxonomy ) ) {
360	return new WP_Error( 'unknown_taxonomy', 'Unknown taxonomy', 404 );
361	}
362
363	if ( false === term_exists( $object_id, $taxonomy_type ) ) {
364	return new WP_Error( 'unknown_taxonomy', 'That taxonomy does not exist', 404 );
365	}
366
367	$args = $this->query_args();
368	$return = $this->get_taxonomy( $taxonomy->slug, $taxonomy_type, $args['context'] );
369	if ( ! $return \|\| is_wp_error( $return ) ) {
370	return $return;
371	}
372
373	/** This action is documented in json-endpoints/class.wpcom-json-api-site-settings-endpoint.php */
374	do_action( 'wpcom_json_api_objects', 'taxonomies' );
375
376	wp_delete_term( $taxonomy->term_id, $taxonomy_type );
377
378	return array(
379	'slug' => (string) $taxonomy->slug,
380	'success' => 'true',
381	);
382	}
383	}
384