class.wpcom-json-api-bulk-update-comments-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.2.4

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

jetpack / json-endpoints Last commit date

class.wpcom-json-api-bulk-update-comments-endpoint.php

234 lines

1	<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Endpoints: /sites/%s/comments/status
4	* /sites/%s/comments/delete
5	*/
6	new WPCOM_JSON_API_Bulk_Update_Comments_Endpoint(
7	array(
8	'description' => 'Update multiple comment\'s status.',
9	'group' => 'comments',
10	'stat' => 'comments:1:bulk-update-status',
11	'min_version' => '1',
12	'max_version' => '1',
13	'method' => 'POST',
14	'path' => '/sites/%s/comments/status',
15	'path_labels' => array(
16	'$site' => '(int\|string) Site ID or domain',
17	),
18	'request_format' => array(
19	'comment_ids' => '(array\|string) An array, or comma-separated list, of Comment IDs to update.',
20	'status' => '(string) The new status value. Allowed values: approved, unapproved, spam, trash',
21	),
22	'response_format' => array(
23	'results' => '(array) An array of updated Comment IDs.',
24	),
25	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/comments/status',
26	'example_request_data' => array(
27	'headers' => array(
28	'authorization' => 'Bearer YOUR_API_TOKEN',
29	),
30	'body' => array(
31	'comment_ids' => array( 881, 882 ),
32	'status' => 'approved',
33	),
34	),
35	)
36	);
37
38	new WPCOM_JSON_API_Bulk_Update_Comments_Endpoint(
39	array(
40	'description' => 'Permanently delete multiple comments. Note: this request will send non-trashed comments to the trash. Trashed comments will be permanently deleted.',
41	'group' => 'comments',
42	'stat' => 'comments:1:bulk-delete',
43	'min_version' => '1',
44	'max_version' => '1',
45	'method' => 'POST',
46	'path' => '/sites/%s/comments/delete',
47	'path_labels' => array(
48	'$site' => '(int\|string) Site ID or domain',
49	),
50	'request_format' => array(
51	'comment_ids' => '(array\|string) An array, or comma-separated list, of Comment IDs to delete or trash. (optional)',
52	'empty_status' => '(string) Force to permanently delete all spam or trash comments. (optional). Allowed values: spam, trash',
53	),
54	'response_format' => array(
55	'results' => '(array) An array of deleted or trashed Comment IDs.',
56	),
57	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/82974409/comments/delete',
58	'example_request_data' => array(
59	'headers' => array(
60	'authorization' => 'Bearer YOUR_API_TOKEN',
61	),
62	'body' => array(
63	'comment_ids' => array( 881, 882 ),
64	),
65	),
66	)
67	);
68
69	/**
70	* Bulk update comments endpoint class.
71	*/
72	class WPCOM_JSON_API_Bulk_Update_Comments_Endpoint extends WPCOM_JSON_API_Endpoint {
73	/**
74	* API callback.
75	*
76	* @param string $path - the path.
77	* @param int $blog_id - the blog ID.
78	*/
79	public function callback( $path = '', $blog_id = 0 ) {
80	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
81	if ( is_wp_error( $blog_id ) ) {
82	return $blog_id;
83	}
84
85	$input = $this->input();
86
87	if ( isset( $input['comment_ids'] ) && is_array( $input['comment_ids'] ) ) {
88	$comment_ids = $input['comment_ids'];
89	} elseif ( isset( $input['comment_ids'] ) && ! empty( $input['comment_ids'] ) ) {
90	$comment_ids = explode( ',', $input['comment_ids'] );
91	} else {
92	$comment_ids = array();
93	}
94
95	$result = array(
96	'results' => array(),
97	);
98
99	wp_defer_comment_counting( true );
100
101	if ( $this->api->ends_with( $path, '/delete' ) ) {
102	if ( isset( $input['empty_status'] ) && $this->validate_empty_status_param( $input['empty_status'] ) ) {
103	$result['results'] = $this->delete_all( $input['empty_status'] );
104	} else {
105	$result['results'] = $this->bulk_delete_comments( $comment_ids );
106	}
107	} else {
108	$status = isset( $input['status'] ) ? $input['status'] : '';
109	$result['results'] = $this->bulk_update_comments_status( $comment_ids, $status );
110	}
111
112	wp_defer_comment_counting( false );
113
114	return $result;
115	}
116
117	/**
118	* Determine if the passed comment status is valid or not.
119	*
120	* @param string $status - status of passed comment.
121	*
122	* @return boolean
123	*/
124	public function validate_status_param( $status ) {
125	return in_array( $status, array( 'approved', 'unapproved', 'pending', 'spam', 'trash' ), true );
126	}
127
128	/**
129	* Determine if the passed empty status is valid or not.
130	*
131	* @param string $empty_status - empty_status of comment.
132	*
133	* @return boolean
134	*/
135	public function validate_empty_status_param( $empty_status ) {
136	return in_array( $empty_status, array( 'spam', 'trash' ), true );
137	}
138
139	/**
140	* Update the status of multiple comments.
141	*
142	* @param array $comment_ids Comments to update.
143	* @param string $status New status value.
144	*
145	* @return array Updated comments IDs.
146	*/
147	public function bulk_update_comments_status( $comment_ids, $status ) {
148	if ( count( $comment_ids ) < 1 ) {
149	return new WP_Error( 'empty_comment_ids', 'The request must include comment_ids', 400 );
150	}
151	if ( ! $this->validate_status_param( $status ) ) {
152	return new WP_Error( 'invalid_status', "Invalid comment status value provided: '$status'.", 400 );
153	}
154	$results = array();
155	foreach ( $comment_ids as $comment_id ) {
156	if ( ! current_user_can( 'edit_comment', $comment_id ) ) {
157	continue;
158	}
159	$result = false;
160	switch ( $status ) {
161	case 'approved':
162	$result = wp_set_comment_status( $comment_id, 'approve' );
163	break;
164	case 'unapproved':
165	case 'pending':
166	$result = wp_set_comment_status( $comment_id, 'hold' );
167	break;
168	case 'spam':
169	$result = wp_spam_comment( $comment_id );
170	break;
171	case 'trash':
172	$result = wp_trash_comment( $comment_id );
173	break;
174	}
175	if ( $result ) {
176	$results[] = $comment_id;
177	}
178	}
179	return $results;
180	}
181
182	/**
183	* Permanenty delete multiple comments.
184	*
185	* Comments are only permanently deleted if trash is disabled or their status is `trash` or `spam`.
186	* Otherwise they are moved to trash.
187	*
188	* @param array $comment_ids Comments to trash or delete.
189	*
190	* @return array Deleted comments IDs.
191	*/
192	public function bulk_delete_comments( $comment_ids ) {
193	if ( count( $comment_ids ) < 1 ) {
194	return new WP_Error( 'empty_comment_ids', 'The request must include comment_ids', 400 );
195	}
196	$results = array();
197	foreach ( $comment_ids as $comment_id ) {
198	if ( ! current_user_can( 'edit_comment', $comment_id ) ) {
199	continue;
200	}
201	if ( wp_delete_comment( $comment_id ) ) {
202	$results[] = $comment_id;
203	}
204	}
205	return $results;
206	}
207
208	/**
209	* Delete all spam or trash comments.
210	*
211	* Comments are only permanently deleted if trash is disabled or their status is `trash` or `spam`.
212	* Otherwise they are moved to trash.
213	*
214	* @param string $status Can be `spam` or `trash`.
215	*
216	* @return array Deleted comments IDs.
217	*/
218	public function delete_all( $status ) {
219	global $wpdb;
220	// This could potentially take a long time, so we only want to delete comments created
221	// before this operation.
222	// Comments marked `spam` or `trash` after this moment won't be touched.
223	// Core uses the `pagegen_timestamp` hidden field for this same reason.
224	$delete_time = gmdate( 'Y-m-d H:i:s' );
225	$comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_approved = %s AND %s > comment_date_gmt", $status, $delete_time ) );
226
227	if ( ! is_countable( $comment_ids ) \|\| array() === $comment_ids ) {
228	return array();
229	}
230
231	return $this->bulk_delete_comments( $comment_ids );
232	}
233	}
234