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

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

411 lines

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