elementor / modules / wp-rest / classes / post-query.php

post-query.php in Elementor Website Builder – more than just a page builder 4.2.0-beta1, at modules/wp-rest/classes/post-query.php

268 lines 8.2 KB

Raw Download Zip

1	<?php
2
3	namespace Elementor\Modules\WpRest\Classes;
4
5	use Elementor\Core\Utils\Collection;
6	use Elementor\Modules\WpRest\Base\Query as Base;
7
8	if ( ! defined( 'ABSPATH' ) ) {
9	exit; // Exit if accessed directly.
10	}
11
12	class Post_Query extends Base {
13	const ENDPOINT = 'post';
14	const SEARCH_FILTER_ACCEPTED_ARGS = 2;
15	const DEFAULT_FORBIDDEN_POST_TYPES = [ 'e-floating-buttons', 'e-landing-page', 'elementor_library', 'attachment', 'revision', 'nav_menu_item', 'custom_css', 'customize_changeset' ];
16	const SEARCH_IN_CONTENT_KEY = 'search_in_content';
17	const ALLOWED_KEYS_CONVERSION_MAP = [
18	'ID' => 'id',
19	'post_title' => 'label',
20	'post_type' => 'groupLabel',
21	];
22
23	/**
24	* @param string $search_term The original search query.
25	* @param \WP_Query $wp_query The WP_Query instance.
26	* @return string Modified search query.
27	*/
28	public function customize_post_query( string $search_term, \WP_Query $wp_query ) {
29	$term = $wp_query->get( 'search_term' ) ?? '';
30	$is_custom_search = $wp_query->get( 'custom_search' ) ?? false;
31
32	if ( $is_custom_search && ! empty( $term ) ) {
33	$escaped = esc_sql( $term );
34	$search_in_content = $wp_query->get( self::SEARCH_IN_CONTENT_KEY ) ?? false;
35	$search_term .= ' AND (';
36	$search_term .= "post_title LIKE '%{$escaped}%'";
37	if ( $search_in_content ) {
38	$search_term .= " OR post_content LIKE '%{$escaped}%'";
39	$search_term .= " OR post_excerpt LIKE '%{$escaped}%'";
40	}
41	if ( ctype_digit( $term ) ) {
42	$search_term .= ' OR ID = ' . intval( $term );
43	} else {
44	$search_term .= " OR ID LIKE '%{$escaped}%'";
45	}
46	$search_term .= ')';
47	}
48
49	return $search_term;
50	}
51
52	/**
53	* @param \WP_REST_Request $request
54	* @return \WP_REST_Response
55	*/
56	protected function get( \WP_REST_Request $request ) {
57	$params = $request->get_params();
58	$term = trim( $params[ self::SEARCH_TERM_KEY ] ?? '' );
59
60	if ( empty( $term ) ) {
61	return new \WP_REST_Response( [
62	'success' => true,
63	'data' => [
64	'value' => [],
65	],
66	], 200 );
67	}
68
69	$keys_format_map = $this->filter_keys_conversion_map(
70	$params[ self::KEYS_CONVERSION_MAP_KEY ] ?? self::ALLOWED_KEYS_CONVERSION_MAP,
71	self::ALLOWED_KEYS_CONVERSION_MAP
72	);
73	$requested_count = $params[ self::ITEMS_COUNT_KEY ] ?? 0;
74	$validated_count = max( $requested_count, 1 );
75	$post_count = min( $validated_count, self::MAX_RESPONSE_COUNT );
76	$is_public_only = $params[ self::IS_PUBLIC_KEY ] ?? true;
77	$post_types = $this->get_post_types_from_params( $request );
78
79	$query_args = [
80	'post_type' => array_keys( $post_types ),
81	'numberposts' => $post_count,
82	'suppress_filters' => false,
83	'custom_search' => true,
84	'search_term' => $term,
85	self::SEARCH_IN_CONTENT_KEY => $params[ self::SEARCH_IN_CONTENT_KEY ] ?? false,
86	'post_status' => $is_public_only ? 'publish' : 'any',
87	'orderby' => 'ID',
88	'order' => 'ASC',
89	];
90
91	if ( ! empty( $params[ self::META_QUERY_KEY ] ) && is_array( $params[ self::META_QUERY_KEY ] ) ) {
92	$query_args['meta_query'] = $params[ self::META_QUERY_KEY ];
93	}
94
95	if ( ! empty( $params[ self::TAX_QUERY_KEY ] ) && is_array( $params[ self::TAX_QUERY_KEY ] ) ) {
96	$query_args['tax_query'] = $params[ self::TAX_QUERY_KEY ];
97	}
98
99	$this->add_filter_to_customize_query();
100	$posts = new Collection( get_posts( $query_args ) );
101	$this->remove_filter_to_customize_query();
102
103	$post_type_labels = ( new Collection( $post_types ) )
104	->map( function ( $pt ) {
105	return $pt->label;
106	} )
107	->all();
108
109	return new \WP_REST_Response( [
110	'success' => true,
111	'data' => [
112	'value' => $posts
113	->filter( function ( $post ) {
114	return current_user_can( 'read_post', $post->ID );
115	} )
116	->map( function ( $post ) use ( $keys_format_map, $post_type_labels ) {
117	$post_type_label = $post->post_type;
118
119	if ( isset( $post_type_labels[ $post->post_type ] ) ) {
120	$post_type_label = $post_type_labels[ $post->post_type ];
121	}
122
123	$post_object = [
124	'ID' => $post->ID,
125	'post_title' => $post->post_title,
126	'post_type' => $post_type_label,
127	];
128
129	return $this->translate_keys( $post_object, $keys_format_map );
130	} )
131	->all(),
132	],
133	], 200 );
134	}
135
136	/**
137	* @return void
138	*/
139	private function add_filter_to_customize_query() {
140	$priority = self::SEARCH_FILTER_PRIORITY;
141	$accepted_args = self::SEARCH_FILTER_ACCEPTED_ARGS;
142
143	add_filter( 'posts_search', [ $this, 'customize_post_query' ], $priority, $accepted_args );
144	}
145
146	/**
147	* @return void
148	*/
149	private function remove_filter_to_customize_query() {
150	$priority = self::SEARCH_FILTER_PRIORITY;
151	$accepted_args = self::SEARCH_FILTER_ACCEPTED_ARGS;
152
153	remove_filter( 'posts_search', [ $this, 'customize_post_query' ], $priority, $accepted_args );
154	}
155
156	protected function permission_check( \WP_REST_Request $request ): bool {
157	return current_user_can( 'edit_posts' );
158	}
159
160	protected function get_endpoint_registration_args(): array {
161	return [
162	self::INCLUDED_TYPE_KEY => [
163	'description' => 'Included post types',
164	'type' => 'array',
165	'required' => false,
166	'default' => null,
167	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
168	],
169	self::EXCLUDED_TYPE_KEY => [
170	'description' => 'Post type to exclude',
171	'type' => 'array',
172	'required' => false,
173	'default' => self::DEFAULT_FORBIDDEN_POST_TYPES,
174	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
175	],
176	self::SEARCH_TERM_KEY => [
177	'description' => 'Posts to search',
178	'type' => 'string',
179	'required' => false,
180	'default' => '',
181	'sanitize_callback' => 'sanitize_text_field',
182	],
183	self::KEYS_CONVERSION_MAP_KEY => [
184	'description' => 'Specify keys to extract and convert, i.e. ["key_1" => "new_key_1"].',
185	'type' => 'array',
186	'required' => false,
187	'default' => [
188	'ID' => 'id',
189	'post_title' => 'label',
190	'post_type' => 'groupLabel',
191	],
192	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
193	],
194	self::ITEMS_COUNT_KEY => [
195	'description' => 'Posts per page',
196	'type' => 'integer',
197	'required' => false,
198	'default' => self::MAX_RESPONSE_COUNT,
199	],
200	self::IS_PUBLIC_KEY => [
201	'description' => 'Whether to include only public post types',
202	'type' => 'boolean',
203	'required' => false,
204	'default' => true,
205	],
206	self::META_QUERY_KEY => [
207	'description' => 'WP_Query meta_query array',
208	'type' => 'array',
209	'required' => false,
210	'default' => null,
211	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
212	],
213	self::TAX_QUERY_KEY => [
214	'description' => 'WP_Query tax_query array',
215	'type' => 'array',
216	'required' => false,
217	'default' => null,
218	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
219	],
220	self::SEARCH_IN_CONTENT_KEY => [
221	'description' => 'Whether to search within post content and excerpt in addition to title',
222	'type' => 'boolean',
223	'required' => false,
224	'default' => false,
225	],
226	];
227	}
228
229	protected static function get_allowed_param_keys(): array {
230	return [
231	self::EXCLUDED_TYPE_KEY,
232	self::INCLUDED_TYPE_KEY,
233	self::KEYS_CONVERSION_MAP_KEY,
234	self::META_QUERY_KEY,
235	self::TAX_QUERY_KEY,
236	self::IS_PUBLIC_KEY,
237	self::ITEMS_COUNT_KEY,
238	self::SEARCH_IN_CONTENT_KEY,
239	];
240	}
241
242	protected static function get_keys_to_encode(): array {
243	return [
244	self::EXCLUDED_TYPE_KEY,
245	self::INCLUDED_TYPE_KEY,
246	self::KEYS_CONVERSION_MAP_KEY,
247	self::META_QUERY_KEY,
248	self::TAX_QUERY_KEY,
249	];
250	}
251
252	private function get_post_types_from_params( \WP_REST_Request $request ) {
253	$included_types = $request->get_param( self::INCLUDED_TYPE_KEY );
254	$excluded_types = $request->get_param( self::EXCLUDED_TYPE_KEY );
255	$post_type_query_args = [
256	'public' => true,
257	];
258
259	$post_types = get_post_types( $post_type_query_args, 'objects' );
260
261	return Collection::make( $post_types )
262	->filter( function ( $slug, $post_type ) use ( $included_types, $excluded_types ) {
263	return ( empty( $included_types ) \|\| in_array( $post_type, $included_types ) ) &&
264	( empty( $excluded_types ) \|\| ! in_array( $post_type, $excluded_types ) );
265	} )->all();
266	}
267	}
268