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

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

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