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

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

jetpack / json-endpoints Last commit date

class.wpcom-json-api-list-post-types-endpoint.php

153 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	/**
4	* List post types endpoint.
5	*/
6	new WPCOM_JSON_API_List_Post_Types_Endpoint(
7	array(
8	'description' => 'Get a list of post types available for a site.',
9	'group' => 'sites',
10	'stat' => 'sites:X:post-types',
11
12	'method' => 'GET',
13	'path' => '/sites/%s/post-types',
14	'path_labels' => array(
15	'$site' => '(int\|string) Site ID or domain',
16	),
17
18	'allow_fallback_to_jetpack_blog_token' => true,
19
20	'query_parameters' => array(
21	'api_queryable' => '(bool) If true, only queryable post types are returned',
22	),
23
24	'response_format' => array(
25	'found' => '(int) The number of post types found',
26	'post_types' => '(array) A list of available post types',
27	),
28	'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/33534099/post-types',
29	)
30	);
31
32	/**
33	* List Post types endpoint class.
34	*
35	* /sites/%s/post-types -> $blog_id
36	*/
37	class WPCOM_JSON_API_List_Post_Types_Endpoint extends WPCOM_JSON_API_Endpoint {
38
39	/**
40	* Post type keys to include.
41	*
42	* @var array
43	*/
44	public static $post_type_keys_to_include = array(
45	'name' => 'name',
46	'label' => 'label',
47	'labels' => 'labels',
48	'description' => 'description',
49	'map_meta_cap' => 'map_meta_cap',
50	'cap' => 'capabilities',
51	'hierarchical' => 'hierarchical',
52	'public' => 'public',
53	'show_ui' => 'show_ui',
54	'publicly_queryable' => 'publicly_queryable',
55	);
56
57	/**
58	* API callback.
59	*
60	* @param string $path - the path.
61	* @param string $blog_id - the blog ID.
62	*/
63	public function callback( $path = '', $blog_id = 0 ) {
64	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
65	if ( is_wp_error( $blog_id ) ) {
66	return $blog_id;
67	}
68
69	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
70	$this->load_theme_functions();
71
72	/**
73	* Whether API responses should be returned in a custom locale. False
74	* for Jetpack; may be true for WP.com requests.
75	*
76	* @since 3.9.2
77	*/
78	if ( apply_filters( 'rest_api_localize_response', false ) ) {
79	// API localization occurs after the initial post types have been
80	// registered, so let's get the post type labels translated.
81	if ( 'en' !== get_locale() ) {
82	global $wp_post_types;
83	foreach ( $wp_post_types as $post_type_object ) {
84	foreach ( array_keys( (array) $post_type_object->labels ) as $label_key ) {
85	// Direct use of translate call because this doesn't need to be extracted.
86	// phpcs:ignore WordPress.WP.I18n
87	$post_type_object->labels->$label_key = translate( $post_type_object->labels->$label_key, 'default' );
88	}
89	}
90	}
91	}
92	}
93
94	// Get a list of available post types.
95	$post_types = get_post_types();
96	$formatted_post_type_objects = array();
97
98	// Retrieve post type object for each post type.
99	foreach ( $post_types as $post_type ) {
100	// Skip non-queryable if filtering on queryable only.
101	$is_queryable = $this->is_post_type_allowed( $post_type );
102	if ( ! $is_queryable ) {
103	continue;
104	}
105
106	$post_type_object = get_post_type_object( $post_type );
107	$formatted_post_type_object = array();
108
109	// Include only the desired keys in the response.
110	foreach ( self::$post_type_keys_to_include as $key => $value ) {
111	$formatted_post_type_object[ $value ] = $post_type_object->{ $key };
112	}
113	$formatted_post_type_object['api_queryable'] = $is_queryable;
114	$formatted_post_type_object['supports'] = get_all_post_type_supports( $post_type );
115	if ( $this->post_type_supports_tags( $post_type ) ) {
116	$formatted_post_type_object['supports']['tags'] = true;
117	}
118
119	$formatted_post_type_objects[] = $formatted_post_type_object;
120	}
121
122	return array(
123	'found' => count( $formatted_post_type_objects ),
124	'post_types' => $formatted_post_type_objects,
125	);
126	}
127
128	/**
129	* See if post type supports tags.
130	*
131	* @param string $post_type - the post type.
132	*/
133	public function post_type_supports_tags( $post_type ) {
134	if ( in_array( 'post_tag', get_object_taxonomies( $post_type ), true ) ) {
135	return true;
136	}
137
138	// the featured content module adds post_tag support
139	// to the post types that are registered for it
140	// however it does so in a way that isn't available
141	// to get_object_taxonomies.
142	$featured_content = get_theme_support( 'featured-content' );
143	if ( ! $featured_content \|\| empty( $featured_content[0] ) \|\| empty( $featured_content[0]['post_types'] ) ) {
144	return false;
145	}
146
147	if ( is_array( $featured_content[0]['post_types'] ) ) {
148	return in_array( $post_type, $featured_content[0]['post_types'], true );
149	}
150	return $post_type === $featured_content[0]['post_types'];
151	}
152	}
153