class.wpcom-json-api-get-comments-tree-v1-2-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.9.2

jetpack / json-endpoints / class.wpcom-json-api-get-comments-tree-v1-2-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-get-comments-tree-v1-2-endpoint.php

161 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	new WPCOM_JSON_API_Get_Comments_Tree_v1_2_Endpoint(
4	array(
5	'description' => 'Get a comments tree for site.',
6	'min_version' => '1.2',
7	'max_version' => '1.2',
8	'group' => 'comments-tree',
9	'stat' => 'comments-tree:1',
10
11	'method' => 'GET',
12	'path' => '/sites/%s/comments-tree',
13	'path_labels' => array(
14	'$site' => '(int\|string) Site ID or domain',
15	),
16	'query_parameters' => array(
17	'post_id' => '(int) Filter returned comments by a post.',
18	'status' => '(string) Filter returned comments based on this value (allowed values: all, approved, pending, trash, spam).',
19	),
20	'response_format' => array(
21	'comments_tree' => '(array) Array of post IDs representing the comments tree for given site or post (max 50000)',
22	'trackbacks_tree' => '(array) Array of post IDs representing the trackbacks tree for given site or post (max 50000)',
23	'pingbacks_tree' => '(array) Array of post IDs representing the pingbacks tree for given site or post (max 50000)',
24	),
25
26	'example_request' => 'https://public-api.wordpress.com/rest/v1.2/sites/en.blog.wordpress.com/comments-tree?&status=approved&post_id=123',
27	)
28	);
29
30	/**
31	* Get comments tree v1_2 endpoint class.
32	*/
33	class WPCOM_JSON_API_Get_Comments_Tree_v1_2_Endpoint extends WPCOM_JSON_API_Get_Comments_Tree_v1_1_Endpoint { // phpcs:ignore
34	/**
35	* Retrieves a list of comment data.
36	*
37	* @param array $args {
38	* Optional. Arguments to control behavior. Default empty array.
39	*
40	* @type int $max_comment_count Maximum number of comments returned.
41	* @type int $post_id Filter by post.
42	* @type int $start_at First comment to search from going back in time.
43	* @type string $status Filter by status: all, approved, pending, spam or trash.
44	* }
45	*
46	* @return array
47	*/
48	public function get_site_tree_v1_2( $args = array() ) {
49	global $wpdb;
50	$defaults = array(
51	'max_comment_count' => 50000,
52	'post_id' => null,
53	'start_at' => PHP_INT_MAX,
54	'status' => 'all',
55	);
56	$args = wp_parse_args( $args, $defaults );
57	$db_status = $this->get_comment_db_status( $args['status'] );
58
59	if ( ! empty( $args['post_id'] ) ) {
60	$db_comment_rows = $wpdb->get_results(
61	$wpdb->prepare(
62	'SELECT comment_ID, comment_parent, comment_type ' .
63	"FROM $wpdb->comments AS comments " .
64	"WHERE comment_ID <= %d AND comment_post_ID = %d AND ( %s = 'all' OR comment_approved = %s ) " .
65	'ORDER BY comment_ID DESC ' .
66	'LIMIT %d',
67	(int) $args['start_at'],
68	(int) $args['post_id'],
69	$db_status,
70	$db_status,
71	$args['max_comment_count']
72	),
73	ARRAY_N
74	);
75	} else {
76	$db_comment_rows = $wpdb->get_results(
77	$wpdb->prepare(
78	'SELECT comment_ID, comment_parent, comment_type, comment_post_ID ' .
79	"FROM $wpdb->comments AS comments " .
80	"INNER JOIN $wpdb->posts AS posts ON comments.comment_post_ID = posts.ID " .
81	"WHERE comment_ID <= %d AND ( %s = 'all' OR comment_approved = %s ) " .
82	'ORDER BY comment_ID DESC ' .
83	'LIMIT %d',
84	(int) $args['start_at'],
85	$db_status,
86	$db_status,
87	$args['max_comment_count']
88	),
89	ARRAY_N
90	);
91	}
92
93	$comments = array();
94	$trackbacks = array();
95	$pingbacks = array();
96	foreach ( $db_comment_rows as $row ) {
97	$comment_id = (int) $row[0];
98	$comment_parent_id = (int) $row[1];
99	$comment_post_id = isset( $args['post_id'] ) ? (int) $args['post_id'] : (int) $row[3];
100
101	if ( ! isset( $comments[ $comment_post_id ] ) ) {
102	$comments[ $comment_post_id ] = array( array(), array() );
103	}
104	switch ( $row[2] ) {
105	case 'trackback':
106	$trackbacks[ $comment_post_id ][] = $comment_id;
107	break;
108	case 'pingback':
109	$pingbacks[ $comment_post_id ][] = $comment_id;
110	break;
111	default:
112	if ( 0 === $comment_parent_id ) {
113	$comments[ $comment_post_id ][0][] = $comment_id;
114	} else {
115	$comments[ $comment_post_id ][1][] = array( $comment_id, $comment_parent_id );
116	}
117	}
118	}
119
120	return array(
121	'comments_tree' => $comments,
122	'trackbacks_tree' => $trackbacks,
123	'pingbacks_tree' => $pingbacks,
124	);
125	}
126
127	/**
128	* Endpoint callback for /sites/%s/comments-tree
129	*
130	* @param string $path - the path.
131	* @param int $blog_id - the blog ID.
132	*
133	* @return array Site or post tree results by status.
134	*/
135	public function callback( $path = '', $blog_id = 0 ) {
136	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
137	if ( is_wp_error( $blog_id ) ) {
138	return $blog_id;
139	}
140
141	$args = $this->query_args();
142	$filters = array();
143
144	if ( ! empty( $args['status'] ) ) {
145	if ( ! $this->validate_status_param( $args['status'] ) ) {
146	return new WP_Error( 'invalid_status', 'Invalid comment status value provided: ' . $args['status'] . '.', 400 );
147	}
148	$filters['status'] = $args['status'];
149	}
150
151	if ( ! empty( $args['post_id'] ) ) {
152	if ( get_post( absint( $args['post_id'] ) ) === null ) {
153	return new WP_Error( 'invalid_post', 'Invalid post', 400 );
154	}
155	$filters['post_id'] = absint( $args['post_id'] );
156	}
157
158	return $this->get_site_tree_v1_2( $filters );
159	}
160	}
161