class.wpcom-json-api-list-dropdown-pages-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 12.0.2

jetpack / json-endpoints / class.wpcom-json-api-list-dropdown-pages-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-list-dropdown-pages-endpoint.php

220 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3	/**
4	* List dropdown pages endpoint.
5	*/
6	new WPCOM_JSON_API_List_Dropdown_Pages_Endpoint(
7	array(
8
9	'description' => 'Get a list of pages to be displayed as options in a select-a-page-dropdown.',
10	'min_version' => '1.1',
11	'max_version' => '1.1',
12
13	'group' => 'posts',
14	'stat' => 'posts:dropdown-pages',
15
16	'method' => 'GET',
17	'path' => '/sites/%s/dropdown-pages/',
18	'path_labels' => array(
19	'$site' => '(int\|string) Site ID or domain',
20	),
21
22	'allow_fallback_to_jetpack_blog_token' => true,
23
24	'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/en.blog.wordpress.com/dropdown-pages/',
25	)
26	);
27
28	/**
29	* Endpoint class responsible for listing pages to be displayed as options in a select-a-page-dropdown.
30	*
31	* /sites/%s/dropdown-pages/ -> $blog_id
32	*/
33	class WPCOM_JSON_API_List_Dropdown_Pages_Endpoint extends WPCOM_JSON_API_Endpoint {
34
35	/**
36	* Page object format.
37	*
38	* @var array
39	*/
40	public $dropdown_page_object_format = array(
41	'ID' => '(int) The page ID.',
42	'title' => '(string) The page title.',
43	'children' => '(array:dropdown_page) An array of child pages.',
44	);
45
46	/**
47	* The response format.
48	*
49	* @var array
50	*/
51	public $response_format = array(
52	'found' => '(int) The number of pages found.',
53	'dropdown_pages' => '(array:dropdown_page) An array of dropdown_page objects.',
54	);
55
56	/**
57	* List of pages indexed by their page ID.
58	*
59	* @var array<int,WP_Post>
60	*/
61	private $pages_by_id = array();
62
63	/**
64	* List of pages indexed by their parent page ID.
65	*
66	* @var array<int,WP_Post>
67	*/
68	private $pages_by_parent = array();
69
70	/**
71	* API callback.
72	*
73	* @param string $path - the path.
74	* @param int $blog_id - the blog ID.
75	* @return stdClass[] $pages - An array of page objects. Each page object includes ID and title properties and may include children property. This makes each page object a tree-like data structure.
76	*/
77	public function callback( $path = '', $blog_id = 0 ) {
78	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
79	if ( is_wp_error( $blog_id ) ) {
80	return $blog_id;
81	}
82
83	$pages = get_pages();
84
85	if ( empty( $pages ) ) {
86	return array(
87	'found' => 0,
88	'dropdown_pages' => array(),
89	);
90	}
91
92	$this->pages_by_id = self::to_pages_by_id( $pages );
93	$this->pages_by_parent = self::to_pages_by_parent( $pages );
94	$dropdown_pages = $this->create_dropdown_pages();
95	return array(
96	'found' => count( $dropdown_pages ),
97	'dropdown_pages' => $dropdown_pages,
98	);
99	}
100
101	/**
102	* Convert a list of pages to a list of pages by page ID.
103	*
104	* @param array<WP_Post> $pages - array of pages.
105	* @return array<int,WP_Post> $pages_by_page_id - indexed array of pages by page ID where index is page ID.
106	*/
107	private static function to_pages_by_id( $pages ) {
108	$pages_by_page_id = array();
109	foreach ( $pages as $page ) {
110	if ( isset( $page->ID ) ) {
111	$pages_by_page_id[ $page->ID ] = $page;
112	}
113	}
114	return $pages_by_page_id;
115	}
116
117	/**
118	* Convert a list of pages to a list of pages by parent.
119	*
120	* @param array<WP_Post> $pages - array of pages.
121	* @return array<int,WP_Post> $pages_by_parent - indexed array of pages by parent where index is page ID.
122	*/
123	private static function to_pages_by_parent( $pages ) {
124	$pages_by_parent = array();
125	foreach ( $pages as $page ) {
126	if ( empty( $page->post_parent ) ) {
127	$pages_by_parent['root'][] = $page;
128	} else {
129	$pages_by_parent[ $page->post_parent ][] = $page;
130	}
131	}
132	return $pages_by_parent;
133	}
134
135	/**
136	* Convert a list of pages to a list of dropdown pages.
137	*
138	* @return array<stdClass> $dropdown_pages - array of dropdown pages.
139	*/
140	private function create_dropdown_pages() {
141	$dropdown_pages = array();
142
143	if ( ! empty( $this->pages_by_parent['root'] ) ) {
144	foreach ( $this->pages_by_parent['root'] as $root_page ) {
145	$dropdown_pages[] = $this->to_dropdown_page( $root_page );
146	}
147	}
148
149	if ( ! empty( $this->pages_by_id ) ) {
150	// In case there were some orphans
151	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
152	foreach ( $this->pages_by_id as $_page_id => $page ) {
153	$dropdown_pages[] = $this->to_dropdown_page( $page );
154	}
155	}
156
157	return $dropdown_pages;
158	}
159
160	/**
161	* Convert a page to a dropdown page.
162	*
163	* @param WP_Post $page - the page.
164	* @return stdClass\|false $dropdown_page - the dropdown page.
165	*/
166	private function to_dropdown_page( $page ) {
167	if ( ! isset( $page->ID ) ) {
168	return false;
169	}
170
171	$title = $this->get_page_title( $page );
172
173	if ( ! isset( $this->pages_by_parent[ $page->ID ] ) ) {
174	unset( $this->pages_by_id[ $page->ID ] );
175	return (object) array(
176	'ID' => $page->ID,
177	'title' => $title,
178	);
179	}
180
181	$children = array();
182	foreach ( $this->pages_by_parent[ $page->ID ] as $child_page ) {
183	$children[] = $this->to_dropdown_page( $child_page );
184	}
185
186	unset( $this->pages_by_id[ $page->ID ] );
187	unset( $this->pages_by_parent[ $page->ID ] );
188	return (object) array(
189	'ID' => $page->ID,
190	'title' => $title,
191	'children' => $children,
192	);
193	}
194
195	/**
196	* Get the page title.
197	*
198	* @param WP_Post $page - the page.
199	* @return string $page_title - the page title.
200	*/
201	private function get_page_title( $page ) {
202	$title = $page->post_title;
203	if ( '' === $title ) {
204	/* translators: %d: ID of a post. */
205	$title = sprintf( __( '#%d (no title)', 'jetpack' ), $page->ID );
206	}
207
208	/**
209	* Filters the page title when creating an HTML drop-down list of pages.
210	*
211	* @since 3.1.0
212	*
213	* @param string $title Page title.
214	* @param WP_Post $page Page data object.
215	*/
216	$title = apply_filters( 'list_pages', $title, $page );
217	return $title;
218	}
219	}
220