class.wpcom-json-api-list-post-type-taxonomies-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.9.2

jetpack / json-endpoints / class.wpcom-json-api-list-post-type-taxonomies-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-list-post-type-taxonomies-endpoint.php

125 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	/**
4	* List post type taxonomies endpoint.
5	*/
6
7	new WPCOM_JSON_API_List_Post_Type_Taxonomies_Endpoint(
8	array(
9	'description' => 'Get a list of taxonomies associated with a post type.',
10	'group' => 'taxonomy',
11	'stat' => 'sites:X:post-types:X:taxonomies',
12	'method' => 'GET',
13	'path' => '/sites/%s/post-types/%s/taxonomies',
14	'path_labels' => array(
15	'$site' => '(int\|string) Site ID or domain',
16	'$post_type' => '(string) Post type',
17	),
18	'response_format' => array(
19	'found' => '(int) The number of taxonomies found',
20	'taxonomies' => '(array:taxonomy) A list of available taxonomies',
21	),
22	'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/33534099/post-types/post/taxonomies',
23	)
24	);
25
26	/**
27	* List post type taxonomies endpoint class.
28	*
29	* /sites/%s/post-types/%s/taxonomies -> $blog_id, $post_type
30	*/
31	class WPCOM_JSON_API_List_Post_Type_Taxonomies_Endpoint extends WPCOM_JSON_API_Endpoint {
32
33	/**
34	* Included taxonomy keys.
35	*
36	* @var array
37	*/
38	public static $taxonomy_keys_to_include = array(
39	'name' => 'name',
40	'label' => 'label',
41	'labels' => 'labels',
42	'description' => 'description',
43	'hierarchical' => 'hierarchical',
44	'public' => 'public',
45	'cap' => 'capabilities',
46	);
47
48	/**
49	* API callback.
50	*
51	* @param string $path - the path.
52	* @param string $blog_id - the blog ID.
53	* @param string $post_type - the post type.
54	*/
55	public function callback( $path = '', $blog_id = 0, $post_type = 'post' ) {
56	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
57	if ( is_wp_error( $blog_id ) ) {
58	return $blog_id;
59	}
60
61	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
62	$this->load_theme_functions();
63	}
64
65	$this->localize_initial_taxonomies( $post_type );
66
67	$post_type_object = get_post_type_object( $post_type );
68	if ( ! $post_type_object \|\| ( ! $post_type_object->publicly_queryable && (
69	! current_user_can( $post_type_object->cap->edit_posts ) ) ) ) {
70	return new WP_Error( 'unknown_post_type', 'Unknown post type', 404 );
71	}
72
73	// Get a list of available taxonomies.
74	$taxonomy_objects = get_object_taxonomies( $post_type, 'objects' );
75
76	// Construct array of formatted objects.
77	$formatted_taxonomy_objects = array();
78	foreach ( $taxonomy_objects as $taxonomy_object ) {
79	// Omit private taxonomies unless user has assign capability.
80	if ( ! $taxonomy_object->public && ! current_user_can( $taxonomy_object->cap->assign_terms ) ) {
81	continue;
82	}
83
84	// Include only the desired keys in the response.
85	$formatted_taxonomy_object = array();
86	foreach ( self::$taxonomy_keys_to_include as $key => $value ) {
87	$formatted_taxonomy_object[ $value ] = $taxonomy_object->{ $key };
88	}
89
90	$formatted_taxonomy_objects[] = $formatted_taxonomy_object;
91	}
92
93	return array(
94	'found' => count( $formatted_taxonomy_objects ),
95	'taxonomies' => $formatted_taxonomy_objects,
96	);
97	}
98
99	/**
100	* Handle localizing initial taxonomies.
101	*
102	* @param string $post_type - the post type.
103	*/
104	protected function localize_initial_taxonomies( $post_type ) {
105	/** This filter is documented in jetpack/json-endpoints/class.wpcom-json-api-list-post-types-endpoint.php */
106	if ( ! apply_filters( 'rest_api_localize_response', false ) ) {
107	return;
108	}
109
110	// Since recreating initial taxonomies will restore the default post
111	// types to which they are associated, save post type's taxonomies in
112	// case it was customized via `register_taxonomy_for_object_type`.
113	$post_type_taxonomies = get_object_taxonomies( $post_type );
114
115	// API localization occurs after the initial taxonomies have been
116	// registered, so re-register if localizing response.
117	create_initial_taxonomies();
118
119	// Restore registered taxonomies for post type.
120	foreach ( $post_type_taxonomies as $taxonomy ) {
121	register_taxonomy_for_object_type( $taxonomy, $post_type );
122	}
123	}
124	}
125