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

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

262 lines 8.1 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	$keys_format_map = $this->filter_keys_conversion_map(
61	$params[ self::KEYS_CONVERSION_MAP_KEY ] ?? self::ALLOWED_KEYS_CONVERSION_MAP,
62	self::ALLOWED_KEYS_CONVERSION_MAP
63	);
64	$requested_count = $params[ self::ITEMS_COUNT_KEY ] ?? 0;
65	$validated_count = max( $requested_count, 1 );
66	$post_count = min( $validated_count, self::MAX_RESPONSE_COUNT );
67	$is_public_only = $params[ self::IS_PUBLIC_KEY ] ?? true;
68	$post_types = $this->get_post_types_from_params( $request );
69
70	$query_args = [
71	'post_type' => array_keys( $post_types ),
72	'numberposts' => $post_count,
73	'suppress_filters' => false,
74	'custom_search' => true,
75	'post_status' => $is_public_only ? 'publish' : 'any',
76	'orderby' => 'modified',
77	'order' => 'DESC',
78	];
79
80	if ( ! empty( $term ) ) {
81	$query_args['search_term'] = $term;
82	$query_args[ self::SEARCH_IN_CONTENT_KEY ] = $params[ self::SEARCH_IN_CONTENT_KEY ] ?? false;
83	}
84
85	if ( ! empty( $params[ self::META_QUERY_KEY ] ) && is_array( $params[ self::META_QUERY_KEY ] ) ) {
86	$query_args['meta_query'] = $params[ self::META_QUERY_KEY ];
87	}
88
89	if ( ! empty( $params[ self::TAX_QUERY_KEY ] ) && is_array( $params[ self::TAX_QUERY_KEY ] ) ) {
90	$query_args['tax_query'] = $params[ self::TAX_QUERY_KEY ];
91	}
92
93	$this->add_filter_to_customize_query();
94	$posts = new Collection( get_posts( $query_args ) );
95	$this->remove_filter_to_customize_query();
96
97	$post_type_labels = ( new Collection( $post_types ) )
98	->map( function ( $pt ) {
99	return $pt->label;
100	} )
101	->all();
102
103	return new \WP_REST_Response( [
104	'success' => true,
105	'data' => [
106	'value' => $posts
107	->filter( function ( $post ) {
108	return current_user_can( 'read_post', $post->ID );
109	} )
110	->map( function ( $post ) use ( $keys_format_map, $post_type_labels ) {
111	$post_type_label = $post->post_type;
112
113	if ( isset( $post_type_labels[ $post->post_type ] ) ) {
114	$post_type_label = $post_type_labels[ $post->post_type ];
115	}
116
117	$post_object = [
118	'ID' => $post->ID,
119	'post_title' => $post->post_title,
120	'post_type' => $post_type_label,
121	];
122
123	return $this->translate_keys( $post_object, $keys_format_map );
124	} )
125	->all(),
126	],
127	], 200 );
128	}
129
130	/**
131	* @return void
132	*/
133	private function add_filter_to_customize_query() {
134	$priority = self::SEARCH_FILTER_PRIORITY;
135	$accepted_args = self::SEARCH_FILTER_ACCEPTED_ARGS;
136
137	add_filter( 'posts_search', [ $this, 'customize_post_query' ], $priority, $accepted_args );
138	}
139
140	/**
141	* @return void
142	*/
143	private function remove_filter_to_customize_query() {
144	$priority = self::SEARCH_FILTER_PRIORITY;
145	$accepted_args = self::SEARCH_FILTER_ACCEPTED_ARGS;
146
147	remove_filter( 'posts_search', [ $this, 'customize_post_query' ], $priority, $accepted_args );
148	}
149
150	protected function permission_check( \WP_REST_Request $request ): bool {
151	return current_user_can( 'edit_posts' );
152	}
153
154	protected function get_endpoint_registration_args(): array {
155	return [
156	self::INCLUDED_TYPE_KEY => [
157	'description' => 'Included post types',
158	'type' => 'array',
159	'required' => false,
160	'default' => null,
161	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
162	],
163	self::EXCLUDED_TYPE_KEY => [
164	'description' => 'Post type to exclude',
165	'type' => 'array',
166	'required' => false,
167	'default' => self::DEFAULT_FORBIDDEN_POST_TYPES,
168	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
169	],
170	self::SEARCH_TERM_KEY => [
171	'description' => 'Posts to search',
172	'type' => 'string',
173	'required' => false,
174	'default' => '',
175	'sanitize_callback' => 'sanitize_text_field',
176	],
177	self::KEYS_CONVERSION_MAP_KEY => [
178	'description' => 'Specify keys to extract and convert, i.e. ["key_1" => "new_key_1"].',
179	'type' => 'array',
180	'required' => false,
181	'default' => [
182	'ID' => 'id',
183	'post_title' => 'label',
184	'post_type' => 'groupLabel',
185	],
186	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
187	],
188	self::ITEMS_COUNT_KEY => [
189	'description' => 'Posts per page',
190	'type' => 'integer',
191	'required' => false,
192	'default' => self::MAX_RESPONSE_COUNT,
193	],
194	self::IS_PUBLIC_KEY => [
195	'description' => 'Whether to include only public post types',
196	'type' => 'boolean',
197	'required' => false,
198	'default' => true,
199	],
200	self::META_QUERY_KEY => [
201	'description' => 'WP_Query meta_query array',
202	'type' => 'array',
203	'required' => false,
204	'default' => null,
205	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
206	],
207	self::TAX_QUERY_KEY => [
208	'description' => 'WP_Query tax_query array',
209	'type' => 'array',
210	'required' => false,
211	'default' => null,
212	'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),
213	],
214	self::SEARCH_IN_CONTENT_KEY => [
215	'description' => 'Whether to search within post content and excerpt in addition to title',
216	'type' => 'boolean',
217	'required' => false,
218	'default' => false,
219	],
220	];
221	}
222
223	protected static function get_allowed_param_keys(): array {
224	return [
225	self::EXCLUDED_TYPE_KEY,
226	self::INCLUDED_TYPE_KEY,
227	self::KEYS_CONVERSION_MAP_KEY,
228	self::META_QUERY_KEY,
229	self::TAX_QUERY_KEY,
230	self::IS_PUBLIC_KEY,
231	self::ITEMS_COUNT_KEY,
232	self::SEARCH_IN_CONTENT_KEY,
233	];
234	}
235
236	protected static function get_keys_to_encode(): array {
237	return [
238	self::EXCLUDED_TYPE_KEY,
239	self::INCLUDED_TYPE_KEY,
240	self::KEYS_CONVERSION_MAP_KEY,
241	self::META_QUERY_KEY,
242	self::TAX_QUERY_KEY,
243	];
244	}
245
246	private function get_post_types_from_params( \WP_REST_Request $request ) {
247	$included_types = $request->get_param( self::INCLUDED_TYPE_KEY );
248	$excluded_types = $request->get_param( self::EXCLUDED_TYPE_KEY );
249	$post_type_query_args = [
250	'public' => true,
251	];
252
253	$post_types = get_post_types( $post_type_query_args, 'objects' );
254
255	return Collection::make( $post_types )
256	->filter( function ( $slug, $post_type ) use ( $included_types, $excluded_types ) {
257	return ( empty( $included_types ) \|\| in_array( $post_type, $included_types ) ) &&
258	( empty( $excluded_types ) \|\| ! in_array( $post_type, $excluded_types ) );
259	} )->all();
260	}
261	}
262