class.wpcom-json-api-get-taxonomies-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.2.4

jetpack / json-endpoints / class.wpcom-json-api-get-taxonomies-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-get-taxonomies-endpoint.php

182 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	new WPCOM_JSON_API_Get_Taxonomies_Endpoint(
4	array(
5	'description' => "Get a list of a site's categories.",
6	'group' => 'taxonomy',
7	'stat' => 'categories',
8	'method' => 'GET',
9	'path' => '/sites/%s/categories',
10	'path_labels' => array(
11	'$site' => '(int\|string) Site ID or domain',
12	),
13	'query_parameters' => array(
14	'number' => '(int=100) The number of categories to return. Limit: 1000.',
15	'offset' => '(int=0) 0-indexed offset.',
16	'page' => '(int) Return the Nth 1-indexed page of categories. Takes precedence over the <code>offset</code> parameter.',
17	'search' => '(string) Limit response to include only categories whose names or slugs match the provided search query.',
18	'order' => array(
19	'ASC' => 'Return categories in ascending order.',
20	'DESC' => 'Return categories in descending order.',
21	),
22	'order_by' => array(
23	'name' => 'Order by the name of each category.',
24	'count' => 'Order by the number of posts in each category.',
25	),
26	),
27	'response_format' => array(
28	'found' => '(int) The number of categories returned.',
29	'categories' => '(array) Array of category objects.',
30	),
31
32	'allow_fallback_to_jetpack_blog_token' => true,
33
34	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/categories/?number=5',
35	)
36	);
37
38	new WPCOM_JSON_API_Get_Taxonomies_Endpoint(
39	array(
40	'description' => "Get a list of a site's tags.",
41	'group' => 'taxonomy',
42	'stat' => 'tags',
43	'method' => 'GET',
44	'path' => '/sites/%s/tags',
45	'path_labels' => array(
46	'$site' => '(int\|string) Site ID or domain',
47	),
48	'query_parameters' => array(
49	'number' => '(int=100) The number of tags to return. Limit: 1000.',
50	'offset' => '(int=0) 0-indexed offset.',
51	'page' => '(int) Return the Nth 1-indexed page of tags. Takes precedence over the <code>offset</code> parameter.',
52	'search' => '(string) Limit response to include only tags whose names or slugs match the provided search query.',
53	'order' => array(
54	'ASC' => 'Return tags in ascending order.',
55	'DESC' => 'Return tags in descending order.',
56	),
57	'order_by' => array(
58	'name' => 'Order by the name of each tag.',
59	'count' => 'Order by the number of posts in each tag.',
60	),
61	),
62
63	'allow_fallback_to_jetpack_blog_token' => true,
64
65	'response_format' => array(
66	'found' => '(int) The number of tags returned.',
67	'tags' => '(array) Array of tag objects.',
68	),
69	'example_request' => 'https://public-api.wordpress.com/rest/v1/sites/en.blog.wordpress.com/tags/?number=5',
70	)
71	);
72
73	/**
74	* GET taxonomies endpoint class.
75	*/
76	class WPCOM_JSON_API_Get_Taxonomies_Endpoint extends WPCOM_JSON_API_Endpoint {
77	/**
78	*
79	* API callback.
80	* /sites/%s/tags -> $blog_id
81	* /sites/%s/categories -> $blog_id
82	*
83	* @param string $path - the path.
84	* @param int $blog_id - the blog ID.
85	*/
86	public function callback( $path = '', $blog_id = 0 ) {
87	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
88	if ( is_wp_error( $blog_id ) ) {
89	return $blog_id;
90	}
91
92	$args = $this->query_args();
93	$args = $this->process_args( $args );
94
95	if ( preg_match( '#/tags#i', $path ) ) {
96	return $this->tags( $args );
97	} else {
98	return $this->categories( $args );
99	}
100	}
101
102	/**
103	* Process args.
104	*
105	* @param array $args - the arguments.
106	*/
107	public function process_args( $args ) {
108	if ( $args['number'] < 1 ) {
109	$args['number'] = 100;
110	} elseif ( 1000 < $args['number'] ) {
111	return new WP_Error( 'invalid_number', 'The NUMBER parameter must be less than or equal to 1000.', 400 );
112	}
113
114	if ( isset( $args['page'] ) ) {
115	if ( $args['page'] < 1 ) {
116	$args['page'] = 1;
117	}
118
119	$args['offset'] = ( $args['page'] - 1 ) * $args['number'];
120	unset( $args['page'] );
121	}
122
123	if ( $args['offset'] < 0 ) {
124	$args['offset'] = 0;
125	}
126
127	$args['orderby'] = $args['order_by'];
128	unset( $args['order_by'] );
129
130	unset( $args['context'], $args['pretty'], $args['http_envelope'], $args['fields'] );
131	return $args;
132	}
133
134	/**
135	* Get categories.
136	*
137	* @param array $args - the arguments.
138	*/
139	public function categories( $args ) {
140	$args['get'] = 'all';
141
142	$cats = get_categories( $args );
143	unset( $args['offset'] );
144	$args['taxonomy'] = 'category';
145	$found = wp_count_terms( $args );
146
147	$cats_obj = array();
148	foreach ( $cats as $cat ) {
149	$cats_obj[] = $this->format_taxonomy( $cat, 'category', 'display' );
150	}
151
152	return array(
153	'found' => (int) $found,
154	'categories' => $cats_obj,
155	);
156	}
157
158	/**
159	* Get tags.
160	*
161	* @param array $args - the arguments.
162	*/
163	public function tags( $args ) {
164	$args['get'] = 'all';
165
166	$tags = (array) get_tags( $args );
167	unset( $args['offset'] );
168	$args['taxonomy'] = 'post_tag';
169	$found = wp_count_terms( $args );
170
171	$tags_obj = array();
172	foreach ( $tags as $tag ) {
173	$tags_obj[] = $this->format_taxonomy( $tag, 'post_tag', 'display' );
174	}
175
176	return array(
177	'found' => (int) $found,
178	'tags' => $tags_obj,
179	);
180	}
181	}
182