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

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

jetpack / json-endpoints Last commit date

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

296 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Update site terms API endpoints.
4	*
5	* Endpoints:
6	* Create a new term: /sites/%s/taxonomies/%s/terms/new
7	* Edit a term: /sites/%s/taxonomies/%s/terms/slug:%s
8	* Delete a term: /sites/%s/taxonomies/%s/terms/slug:%s/delete
9	*/
10
11	new WPCOM_JSON_API_Update_Term_Endpoint(
12	array(
13	'description' => 'Create a new term.',
14	'group' => 'taxonomy',
15	'stat' => 'terms:new',
16	'method' => 'POST',
17	'path' => '/sites/%s/taxonomies/%s/terms/new',
18	'path_labels' => array(
19	'$site' => '(int\|string) Site ID or domain',
20	'$taxonomy' => '(string) Taxonomy',
21	),
22	'request_format' => array(
23	'name' => '(string) Name of the term',
24	'description' => '(string) A description of the term',
25	'parent' => '(int) The parent ID for the term, if hierarchical',
26	),
27	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/taxonomies/post_tag/terms/new',
28	'example_request_data' => array(
29	'headers' => array(
30	'authorization' => 'Bearer YOUR_API_TOKEN',
31	),
32	'body' => array(
33	'name' => 'Ribs & Chicken',
34	),
35	),
36	)
37	);
38
39	new WPCOM_JSON_API_Update_Term_Endpoint(
40	array(
41	'description' => 'Edit a term.',
42	'group' => 'taxonomy',
43	'stat' => 'terms:1:POST',
44	'method' => 'POST',
45	'path' => '/sites/%s/taxonomies/%s/terms/slug:%s',
46	'path_labels' => array(
47	'$site' => '(int\|string) Site ID or domain',
48	'$taxonomy' => '(string) Taxonomy',
49	'$slug' => '(string) The term slug',
50	),
51	'request_format' => array(
52	'name' => '(string) Name of the term',
53	'description' => '(string) A description of the term',
54	'parent' => '(int) The parent ID for the term, if hierarchical',
55	),
56	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/taxonomies/post_tag/terms/slug:testing-term',
57	'example_request_data' => array(
58	'headers' => array(
59	'authorization' => 'Bearer YOUR_API_TOKEN',
60	),
61	'body' => array(
62	'description' => 'The most delicious',
63	),
64	),
65	)
66	);
67
68	new WPCOM_JSON_API_Update_Term_Endpoint(
69	array(
70	'description' => 'Delete a term.',
71	'group' => 'taxonomy',
72	'stat' => 'terms:1:delete',
73	'method' => 'POST',
74	'path' => '/sites/%s/taxonomies/%s/terms/slug:%s/delete',
75	'path_labels' => array(
76	'$site' => '(int\|string) Site ID or domain',
77	'$taxonomy' => '(string) Taxonomy',
78	'$slug' => '(string) The term slug',
79	),
80	'response_format' => array(
81	'slug' => '(string) The slug of the deleted term',
82	'success' => '(bool) Whether the operation was successful',
83	),
84	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/taxonomies/post_tag/terms/slug:$term/delete',
85	'example_request_data' => array(
86	'headers' => array(
87	'authorization' => 'Bearer YOUR_API_TOKEN',
88	),
89	),
90	)
91	);
92
93	/**
94	* Update site terms API endpoint class.
95	*/
96	class WPCOM_JSON_API_Update_Term_Endpoint extends WPCOM_JSON_API_Taxonomy_Endpoint {
97	/**
98	* Update site terms API callback.
99	*
100	* - /sites/%s/taxonomies/%s/terms/new -> $blog_id, $taxonomy
101	* - /sites/%s/taxonomies/%s/terms/slug:%s -> $blog_id, $taxonomy, $slug
102	* - /sites/%s/taxonomies/%s/terms/slug:%s/delete -> $blog_id, $taxonomy, $slug
103	*
104	* @param string $path API path.
105	* @param int $blog_id Blog ID.
106	* @param string $taxonomy Taxonomy.
107	* @param int\|string $slug Slug, term name.
108	*/
109	public function callback( $path = '', $blog_id = 0, $taxonomy = 'category', $slug = 0 ) {
110	$slug = urldecode( $slug );
111	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
112	if ( is_wp_error( $blog_id ) ) {
113	return $blog_id;
114	}
115
116	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
117	$this->load_theme_functions();
118	}
119
120	$user = wp_get_current_user();
121	if ( ! $user \|\| is_wp_error( $user ) \|\| ! $user->ID ) {
122	return new WP_Error( 'authorization_required', 'An active access token must be used to manage taxonomies.', 403 );
123	}
124
125	$taxonomy_meta = get_taxonomy( $taxonomy );
126	if ( false === $taxonomy_meta \|\| (
127	! $taxonomy_meta->public &&
128	! current_user_can( $taxonomy_meta->cap->manage_terms ) &&
129	! current_user_can( $taxonomy_meta->cap->edit_terms ) &&
130	! current_user_can( $taxonomy_meta->cap->delete_terms ) ) ) {
131	return new WP_Error( 'invalid_taxonomy', 'The taxonomy does not exist', 400 );
132	}
133
134	if ( $this->api->ends_with( $path, '/delete' ) ) {
135	return $this->delete_term( $path, $blog_id, $slug, $taxonomy );
136	} elseif ( $this->api->ends_with( $path, '/new' ) ) {
137	return $this->new_term( $path, $blog_id, $taxonomy );
138	}
139
140	return $this->update_term( $path, $blog_id, $slug, $taxonomy );
141	}
142
143	/**
144	* Create a new term.
145	*
146	* - /sites/%s/taxonomies/%s/terms/new -> $blog_id, $taxonomy
147	*
148	* @param string $path API path.
149	* @param int $blog_id Blog ID.
150	* @param string $taxonomy Taxonomy.
151	*/
152	public function new_term( $path, $blog_id, $taxonomy ) {
153	$args = $this->query_args();
154	$input = $this->input();
155	if ( ! is_array( $input ) \|\| ! $input \|\| ! strlen( $input['name'] ) ) {
156	return new WP_Error( 'invalid_input', 'Unknown data passed', 400 );
157	}
158
159	$tax = get_taxonomy( $taxonomy );
160	if ( ! current_user_can( $tax->cap->manage_terms ) ) {
161	return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
162	}
163
164	if ( ! isset( $input['parent'] ) \|\| ! is_taxonomy_hierarchical( $taxonomy ) ) {
165	$input['parent'] = 0;
166	}
167
168	$term = get_term_by( 'name', $input['name'], $taxonomy );
169	if ( $term ) {
170	// the same name is allowed as long as the parents are different.
171	if ( $input['parent'] === $term->parent ) {
172	return new WP_Error( 'duplicate', 'A taxonomy with that name already exists', 409 );
173	}
174	}
175
176	$data = wp_insert_term(
177	addslashes( $input['name'] ),
178	$taxonomy,
179	array(
180	'description' => isset( $input['description'] ) ? addslashes( $input['description'] ) : '',
181	'parent' => $input['parent'],
182	)
183	);
184
185	if ( is_wp_error( $data ) ) {
186	return $data;
187	}
188
189	$term = get_term_by( 'id', $data['term_id'], $taxonomy );
190
191	$return = $this->get_taxonomy( $term->slug, $taxonomy, $args['context'] );
192	if ( ! $return \|\| is_wp_error( $return ) ) {
193	return $return;
194	}
195
196	/** This action is documented in json-endpoints/class.wpcom-json-api-site-settings-endpoint.php */
197	do_action( 'wpcom_json_api_objects', 'terms' );
198	return $return;
199	}
200
201	/**
202	* Update a term.
203	*
204	* - /sites/%s/taxonomies/%s/terms/slug:%s -> $blog_id, $taxonomy, $slug
205	*
206	* @param string $path API path.
207	* @param int $blog_id Blog ID.
208	* @param int\|string $slug Slug, term name.
209	* @param string $taxonomy Taxonomy.
210	*/
211	public function update_term( $path, $blog_id, $slug, $taxonomy ) {
212	$tax = get_taxonomy( $taxonomy );
213	if ( ! current_user_can( $tax->cap->edit_terms ) ) {
214	return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
215	}
216
217	$term = get_term_by( 'slug', $slug, $taxonomy );
218	if ( ! $term \|\| is_wp_error( $term ) ) {
219	return new WP_Error( 'unknown_taxonomy', 'Unknown taxonomy', 404 );
220	}
221
222	$args = $this->query_args();
223	$input = $this->input( false );
224	if ( ! is_array( $input ) \|\| ! $input ) {
225	return new WP_Error( 'invalid_input', 'Invalid request input', 400 );
226	}
227
228	$update = array();
229	if ( ! empty( $input['parent'] ) \|\| is_taxonomy_hierarchical( $taxonomy ) ) {
230	$update['parent'] = $input['parent'];
231	}
232
233	if ( isset( $input['description'] ) ) {
234	$update['description'] = addslashes( $input['description'] );
235	}
236
237	if ( ! empty( $input['name'] ) ) {
238	$update['name'] = addslashes( $input['name'] );
239	}
240
241	$data = wp_update_term( $term->term_id, $taxonomy, $update );
242	if ( is_wp_error( $data ) ) {
243	return $data;
244	}
245
246	$term = get_term_by( 'id', $data['term_id'], $taxonomy );
247
248	$return = $this->get_taxonomy( $term->slug, $taxonomy, $args['context'] );
249	if ( ! $return \|\| is_wp_error( $return ) ) {
250	return $return;
251	}
252
253	/** This action is documented in json-endpoints/class.wpcom-json-api-site-settings-endpoint.php */
254	do_action( 'wpcom_json_api_objects', 'terms' );
255	return $return;
256	}
257
258	/**
259	* Delete a term.
260	*
261	* - /sites/%s/taxonomies/%s/terms/slug:%s/delete -> $blog_id, $taxonomy, $slug
262	*
263	* @param string $path API path.
264	* @param int $blog_id Blog ID.
265	* @param int\|string $slug Slug, term name.
266	* @param string $taxonomy Taxonomy.
267	*/
268	public function delete_term( $path, $blog_id, $slug, $taxonomy ) {
269	$term = get_term_by( 'slug', $slug, $taxonomy );
270	$tax = get_taxonomy( $taxonomy );
271	if ( ! current_user_can( $tax->cap->delete_terms ) ) {
272	return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
273	}
274
275	if ( ! $term \|\| is_wp_error( $term ) ) {
276	return new WP_Error( 'unknown_taxonomy', 'Unknown taxonomy', 404 );
277	}
278
279	$args = $this->query_args();
280	$return = $this->get_taxonomy( $term->slug, $taxonomy, $args['context'] );
281	if ( ! $return \|\| is_wp_error( $return ) ) {
282	return $return;
283	}
284
285	/** This action is documented in json-endpoints/class.wpcom-json-api-site-settings-endpoint.php */
286	do_action( 'wpcom_json_api_objects', 'terms' );
287
288	wp_delete_term( $term->term_id, $taxonomy );
289
290	return array(
291	'slug' => (string) $term->slug,
292	'success' => true,
293	);
294	}
295	}
296