class.wpcom-json-api-list-posts-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 14.6.1

jetpack / json-endpoints / class.wpcom-json-api-list-posts-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-list-posts-endpoint.php

405 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	/**
4	* List posts endpoint.
5	*/
6	new WPCOM_JSON_API_List_Posts_Endpoint(
7	array(
8	'description' => 'Get a list of matching posts.',
9	'new_version' => '1.1',
10	'max_version' => '1',
11	'group' => 'posts',
12	'stat' => 'posts',
13
14	'method' => 'GET',
15	'path' => '/sites/%s/posts/',
16	'path_labels' => array(
17	'$site' => '(int\|string) Site ID or domain',
18	),
19	'rest_route' => '/posts',
20	'rest_min_jp_version' => '14.5-a.2',
21
22	'allow_fallback_to_jetpack_blog_token' => true,
23
24	'query_parameters' => array(
25	'number' => '(int=20) The number of posts to return. Limit: 100.',
26	'offset' => '(int=0) 0-indexed offset.',
27	'page' => '(int) Return the Nth 1-indexed page of posts. Takes precedence over the <code>offset</code> parameter.',
28	'order' => array(
29	'DESC' => 'Return posts in descending order. For dates, that means newest to oldest.',
30	'ASC' => 'Return posts in ascending order. For dates, that means oldest to newest.',
31	),
32	'order_by' => array(
33	'date' => 'Order by the created time of each post.',
34	'modified' => 'Order by the modified time of each post.',
35	'title' => "Order lexicographically by the posts' titles.",
36	'comment_count' => 'Order by the number of comments for each post.',
37	'ID' => 'Order by post ID.',
38	),
39	'after' => '(ISO 8601 datetime) Return posts dated on or after the specified datetime.',
40	'before' => '(ISO 8601 datetime) Return posts dated on or before the specified datetime.',
41	'tag' => '(string) Specify the tag name or slug.',
42	'category' => '(string) Specify the category name or slug.',
43	'term' => '(object:string) Specify comma-separated term slugs to search within, indexed by taxonomy slug.',
44	'type' => "(string) Specify the post type. Defaults to 'post', use 'any' to query for both posts and pages. Post types besides post and page need to be whitelisted using the <code>rest_api_allowed_post_types</code> filter.",
45	'parent_id' => '(int) Returns only posts which are children of the specified post. Applies only to hierarchical post types.',
46	'include' => '(array:int\|int) Includes the specified post ID(s) in the response',
47	'exclude' => '(array:int\|int) Excludes the specified post ID(s) from the response',
48	'exclude_tree' => '(int) Excludes the specified post and all of its descendants from the response. Applies only to hierarchical post types.',
49	'status' => array(
50	'publish' => 'Return only published posts.',
51	'private' => 'Return only private posts.',
52	'draft' => 'Return only draft posts.',
53	'pending' => 'Return only posts pending editorial approval.',
54	'future' => 'Return only posts scheduled for future publishing.',
55	'trash' => 'Return only posts in the trash.',
56	'any' => 'Return all posts regardless of status.',
57	),
58	'sticky' => array(
59	'false' => 'Post is not marked as sticky.',
60	'true' => 'Stick the post to the front page.',
61	),
62	'author' => "(int) Author's user ID",
63	'search' => '(string) Search query',
64	'meta_key' => '(string) Metadata key that the post should contain',
65	'meta_value' => '(string) Metadata value that the post should contain. Will only be applied if a `meta_key` is also given',
66	),
67
68	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/posts/?number=5',
69	)
70	);
71
72	/**
73	* List posts endpoint class.
74	*
75	* /sites/%s/posts/ -> $blog_id
76	*/
77	class WPCOM_JSON_API_List_Posts_Endpoint extends WPCOM_JSON_API_Post_Endpoint {
78
79	/**
80	* The date range.
81	*
82	* @var array
83	*/
84	public $date_range = array();
85
86	/**
87	* The response format.
88	*
89	* @var array
90	*/
91	public $response_format = array(
92	'found' => '(int) The total number of posts found that match the request (ignoring limits, offsets, and pagination).',
93	'posts' => '(array:post) An array of post objects.',
94	);
95
96	/**
97	* API callback.
98	*
99	* @param string $path - the path.
100	* @param string $blog_id - the blog ID.
101	*/
102	public function callback( $path = '', $blog_id = 0 ) {
103	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
104	if ( is_wp_error( $blog_id ) ) {
105	return $blog_id;
106	}
107
108	$args = $this->query_args();
109
110	if ( $args['number'] < 1 ) {
111	$args['number'] = 20;
112	} elseif ( 100 < $args['number'] ) {
113	return new WP_Error( 'invalid_number', 'The NUMBER parameter must be less than or equal to 100.', 400 );
114	}
115
116	if ( isset( $args['type'] ) && ! $this->is_post_type_allowed( $args['type'] ) ) {
117	return new WP_Error( 'unknown_post_type', 'Unknown post type', 404 );
118	}
119
120	// Normalize post_type.
121	if ( isset( $args['type'] ) && 'any' === $args['type'] ) {
122	if ( version_compare( $this->api->version, '1.1', '<' ) ) {
123	$args['type'] = array( 'post', 'page' );
124	} else { // 1.1+
125	$args['type'] = $this->_get_whitelisted_post_types();
126	}
127	}
128
129	// determine statuses.
130	$status = $args['status'];
131	$status = ( $status ) ? explode( ',', $status ) : array( 'publish' );
132	if ( is_user_logged_in() ) {
133	$statuses_whitelist = array(
134	'publish',
135	'pending',
136	'draft',
137	'future',
138	'private',
139	'trash',
140	'any',
141	);
142	$status = array_intersect( $status, $statuses_whitelist );
143	} else {
144	// logged-out users can see only published posts.
145	$statuses_whitelist = array( 'publish', 'any' );
146	$status = array_intersect( $status, $statuses_whitelist );
147
148	if ( empty( $status ) ) {
149	// requested only protected statuses? nothing for you here.
150	return array(
151	'found' => 0,
152	'posts' => array(),
153	);
154	}
155	// clear it (AKA published only) because "any" includes protected.
156	$status = array();
157	}
158
159	// let's be explicit about defaulting to 'post'.
160	$args['type'] = isset( $args['type'] ) ? $args['type'] : 'post';
161
162	// make sure the user can read or edit the requested post type(s).
163	if ( is_array( $args['type'] ) ) {
164	$allowed_types = array();
165	foreach ( $args['type'] as $post_type ) {
166	if ( $this->current_user_can_access_post_type( $post_type, $args['context'] ) ) {
167	$allowed_types[] = $post_type;
168	}
169	}
170
171	if ( empty( $allowed_types ) ) {
172	return array(
173	'found' => 0,
174	'posts' => array(),
175	);
176	}
177	$args['type'] = $allowed_types;
178	} elseif ( ! $this->current_user_can_access_post_type( $args['type'], $args['context'] ) ) {
179	return array(
180	'found' => 0,
181	'posts' => array(),
182	);
183	}
184
185	$query = array(
186	'posts_per_page' => $args['number'],
187	'order' => $args['order'],
188	'orderby' => $args['order_by'],
189	'post_type' => $args['type'],
190	'post_status' => $status,
191	'post_parent' => isset( $args['parent_id'] ) ? $args['parent_id'] : null,
192	'author' => isset( $args['author'] ) && 0 < $args['author'] ? $args['author'] : null,
193	's' => isset( $args['search'] ) && '' !== $args['search'] ? $args['search'] : null,
194	'fields' => 'ids',
195	);
196
197	if ( ! is_user_logged_in() ) {
198	$query['has_password'] = false;
199	}
200
201	if ( isset( $args['include'] ) ) {
202	$query['post__in'] = is_array( $args['include'] ) ? $args['include'] : array( (int) $args['include'] );
203	}
204
205	if ( isset( $args['meta_key'] ) ) {
206	$show = false;
207	if ( WPCOM_JSON_API_Metadata::is_public( $args['meta_key'] ) ) {
208	$show = true;
209	}
210	if ( current_user_can( 'edit_post_meta', $query['post_type'], $args['meta_key'] ) ) {
211	$show = true;
212	}
213
214	if ( is_protected_meta( $args['meta_key'], 'post' ) && ! $show ) {
215	return new WP_Error( 'invalid_meta_key', 'Invalid meta key', 404 );
216	}
217
218	$meta = array( 'key' => $args['meta_key'] );
219	if ( isset( $args['meta_value'] ) ) {
220	$meta['value'] = $args['meta_value'];
221	}
222
223	$query['meta_query'] = array( $meta );
224	}
225
226	$sticky = get_option( 'sticky_posts' );
227	if (
228	isset( $args['sticky'] )
229	&&
230	$sticky
231	&&
232	is_array( $sticky )
233	) {
234	if ( $args['sticky'] ) {
235	$query['post__in'] = isset( $args['include'] ) ? array_merge( $query['post__in'], $sticky ) : $sticky;
236	} else {
237	$query['post__not_in'] = $sticky;
238	$query['ignore_sticky_posts'] = 1;
239	}
240	} else {
241	$query['post__not_in'] = $sticky;
242	$query['ignore_sticky_posts'] = 1;
243	}
244
245	if ( isset( $args['exclude'] ) ) {
246	$query['post__not_in'] = array_merge( $query['post__not_in'], (array) $args['exclude'] );
247	}
248
249	if ( isset( $args['exclude_tree'] ) && is_post_type_hierarchical( $args['type'] ) ) {
250	// get_page_children is a misnomer; it supports all hierarchical post types.
251	$page_args = array(
252	'child_of' => $args['exclude_tree'],
253	'post_type' => $args['type'],
254	// since we're looking for things to exclude, be aggressive.
255	'post_status' => 'publish,draft,pending,private,future,trash',
256	);
257	$post_descendants = get_pages( $page_args );
258
259	$exclude_tree = array( $args['exclude_tree'] );
260	foreach ( $post_descendants as $child ) {
261	$exclude_tree[] = $child->ID;
262	}
263
264	$query['post__not_in'] = isset( $query['post__not_in'] ) ? array_merge( $query['post__not_in'], $exclude_tree ) : $exclude_tree;
265	}
266
267	if ( isset( $args['category'] ) ) {
268	$category = get_term_by( 'slug', $args['category'], 'category' );
269	if ( false === $category ) {
270	$query['category_name'] = $args['category'];
271	} else {
272	$query['cat'] = $category->term_id;
273	}
274	}
275
276	if ( isset( $args['tag'] ) ) {
277	$query['tag'] = $args['tag'];
278	}
279
280	if ( ! empty( $args['term'] ) ) {
281	$query['tax_query'] = array();
282	foreach ( $args['term'] as $taxonomy => $slug ) {
283	$taxonomy_object = get_taxonomy( $taxonomy );
284	if ( false === $taxonomy_object \|\| ( ! $taxonomy_object->public &&
285	! current_user_can( $taxonomy_object->cap->assign_terms ) ) ) {
286	continue;
287	}
288
289	$query['tax_query'][] = array(
290	'taxonomy' => $taxonomy,
291	'field' => 'slug',
292	'terms' => explode( ',', $slug ),
293	);
294	}
295	}
296
297	if ( isset( $args['page'] ) ) {
298	if ( $args['page'] < 1 ) {
299	$args['page'] = 1;
300	}
301
302	$query['paged'] = $args['page'];
303	} else {
304	if ( $args['offset'] < 0 ) {
305	$args['offset'] = 0;
306	}
307
308	$query['offset'] = $args['offset'];
309	}
310
311	if ( isset( $args['before'] ) ) {
312	$this->date_range['before'] = $args['before'];
313	}
314	if ( isset( $args['after'] ) ) {
315	$this->date_range['after'] = $args['after'];
316	}
317
318	if ( $this->date_range ) {
319	add_filter( 'posts_where', array( $this, 'handle_date_range' ) );
320	}
321
322	/**
323	* 'column' necessary for the me/posts endpoint (which extends sites/$site/posts).
324	* Would need to be added to the sites/$site/posts definition if we ever want to
325	* use it there.
326	*/
327	$column_whitelist = array( 'post_modified_gmt' );
328	if ( isset( $args['column'] ) && in_array( $args['column'], $column_whitelist, true ) ) {
329	$query['column'] = $args['column'];
330	}
331
332	$wp_query = new WP_Query( $query );
333	if ( $this->date_range ) {
334	remove_filter( 'posts_where', array( $this, 'handle_date_range' ) );
335	$this->date_range = array();
336	}
337
338	$return = array();
339	$excluded_count = 0;
340	foreach ( array_keys( $this->response_format ) as $key ) {
341	switch ( $key ) {
342	case 'found':
343	$return[ $key ] = (int) $wp_query->found_posts;
344	break;
345	case 'posts':
346	$posts = array();
347	foreach ( $wp_query->posts as $post_ID ) {
348	$the_post = $this->get_post_by( 'ID', $post_ID, $args['context'] );
349	if ( $the_post && ! is_wp_error( $the_post ) ) {
350	$posts[] = $the_post;
351	} else {
352	++$excluded_count;
353	}
354	}
355
356	if ( $posts ) {
357	/** This action is documented in json-endpoints/class.wpcom-json-api-site-settings-endpoint.php */
358	do_action( 'wpcom_json_api_objects', 'posts', count( $posts ) );
359	}
360
361	$return[ $key ] = $posts;
362	break;
363	}
364	}
365
366	$return['found'] -= $excluded_count;
367
368	return $return;
369	}
370
371	/**
372	* Handle the date range.
373	*
374	* @param string $where - SQL where clause.
375	*/
376	public function handle_date_range( $where ) {
377	global $wpdb;
378
379	switch ( count( $this->date_range ) ) {
380	case 2:
381	$where .= $wpdb->prepare(
382	" AND `$wpdb->posts`.post_date BETWEEN CAST( %s AS DATETIME ) AND CAST( %s AS DATETIME ) ",
383	$this->date_range['after'],
384	$this->date_range['before']
385	);
386	break;
387	case 1:
388	if ( isset( $this->date_range['before'] ) ) {
389	$where .= $wpdb->prepare(
390	" AND `$wpdb->posts`.post_date <= CAST( %s AS DATETIME ) ",
391	$this->date_range['before']
392	);
393	} else {
394	$where .= $wpdb->prepare(
395	" AND `$wpdb->posts`.post_date >= CAST( %s AS DATETIME ) ",
396	$this->date_range['after']
397	);
398	}
399	break;
400	}
401
402	return $where;
403	}
404	}
405