tablepress / controllers / controller-frontend.php

controller-frontend.php in TablePress – Tables in WordPress made easy 3.2, at controllers/controller-frontend.php

1,233 lines 49.6 KB

Raw Download Zip

1	<?php
2	/**
3	* Frontend Controller for TablePress with functionality for the frontend
4	*
5	* @package TablePress
6	* @subpackage Controllers
7	* @author Tobias Bäthge
8	* @since 1.0.0
9	*/
10
11	// Prohibit direct script loading.
12	defined( 'ABSPATH' ) \|\| die( 'No direct script access allowed!' );
13
14	/**
15	* Frontend Controller class, extends Base Controller Class
16	*
17	* @package TablePress
18	* @subpackage Controllers
19	* @author Tobias Bäthge
20	* @since 1.0.0
21	*/
22	class TablePress_Frontend_Controller extends TablePress_Controller {
23
24	/**
25	* Whether to use the legacy CSS loading method of enqueuing all CSS files on all pages.
26	*
27	* @since 3.0.1
28	*/
29	public bool $use_legacy_css_loading = false;
30
31	/**
32	* File name of the admin screens' parent page in the admin menu.
33	*
34	* @since 1.0.0
35	*/
36	public string $parent_page = 'middle';
37
38	/**
39	* Whether TablePress admin screens are a top-level menu item in the admin menu.
40	*
41	* @since 1.0.0
42	*/
43	public bool $is_top_level_page = false;
44
45	/**
46	* List of tables that are shown for the current request.
47	*
48	* @since 1.0.0
49	* @var array<string, array{count: int, instances: array<string, array<string, mixed>>}>
50	*/
51	protected array $shown_tables = array();
52
53	/**
54	* List of registered DataTables datetime formats.
55	*
56	* @since 3.0.0
57	* @var string[]
58	*/
59	protected array $datatables_datetime_formats = array();
60
61	/**
62	* Initiates Frontend functionality.
63	*
64	* @since 1.0.0
65	*/
66	public function __construct() {
67	parent::__construct();
68
69	/**
70	* Filters the admin menu parent page, which is needed for the construction of plugin URLs.
71	*
72	* @since 1.0.0
73	*
74	* @param string $parent_page Current admin menu parent page.
75	*/
76	$this->parent_page = apply_filters( 'tablepress_admin_menu_parent_page', TablePress::$model_options->get( 'admin_menu_parent_page' ) );
77	$this->is_top_level_page = in_array( $this->parent_page, array( 'top', 'middle', 'bottom' ), true );
78
79	/**
80	* Filters whether TablePress should load its frontend CSS files on all pages.
81	* For block themes, the default behavior is to only load the CSS files when a table is encountered on the page.
82	* If Elementor is active, the CSS is also loaded on the editor page.
83	*
84	* @since 3.0.1
85	*
86	* @param bool $use_legacy_css_loading Whether TablePress should load its frontend CSS files on all pages.
87	*/
88	$this->use_legacy_css_loading = apply_filters( 'tablepress_frontend_legacy_css_loading', ! wp_is_block_theme() \|\| ( isset( $_GET['elementor-preview'] ) && is_plugin_active( 'elementor/elementor.php' ) ) );
89
90	if ( $this->use_legacy_css_loading ) {
91	add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_css' ) );
92	}
93
94	add_action( 'wp_print_footer_scripts', array( $this, 'add_datatables_calls' ), 9 ); // Priority 9 so that this runs before `_wp_footer_scripts()`.
95
96	// Register TablePress Shortcodes. Priority 20 is kept for backwards-compatibility purposes.
97	add_action( 'init', array( $this, 'init_shortcodes' ), 20 );
98
99	/**
100	* Filters whether the WordPress search shall also search TablePress tables.
101	*
102	* @since 1.0.0
103	*
104	* @param bool $search Whether the TablePress tables shall be searched. Default true.
105	*/
106	if ( apply_filters( 'tablepress_wp_search_integration', true ) ) {
107	// Extend WordPress Search to also find posts/pages that have a table with the one of the search terms in title (if shown), description (if shown), or content.
108	add_filter( 'posts_search', array( $this, 'posts_search_filter' ) );
109	}
110
111	/**
112	* Load TablePress Template Tag functions.
113	*/
114	TablePress::load_file( 'template-tag-functions.php', 'controllers' );
115
116	/**
117	* Register the tablepress/table block and its dependencies.
118	*/
119	if ( function_exists( 'wp_register_block_metadata_collection' ) ) {
120	// wp_register_block_metadata_collection() is only available since WP 6.7.
121	wp_register_block_metadata_collection(
122	TABLEPRESS_ABSPATH . 'blocks',
123	TABLEPRESS_ABSPATH . 'blocks/blocks-manifest.php',
124	);
125	}
126	register_block_type_from_metadata(
127	TABLEPRESS_ABSPATH . 'blocks/table/block.json',
128	array(
129	'render_callback' => array( $this, 'table_block_render_callback' ),
130	),
131	);
132
133	/**
134	* Register the TablePress Elementor widgets.
135	*/
136	add_action( 'elementor/widgets/register', array( $this, 'register_elementor_widgets' ) );
137	add_action( 'elementor/editor/after_enqueue_styles', array( $this, 'enqueue_elementor_editor_styles' ), 10, 0 );
138	}
139
140	/**
141	* Registers TablePress Shortcodes.
142	*
143	* @since 1.0.0
144	*/
145	public function init_shortcodes(): void {
146	add_shortcode( TablePress::$shortcode, array( $this, 'shortcode_table' ) );
147	add_shortcode( TablePress::$shortcode_info, array( $this, 'shortcode_table_info' ) );
148	}
149
150	/**
151	* Checks if the CSS files for TablePress default CSS and "Custom CSS" should be loaded.
152	*
153	* This function is only called when a [table /] Shortcode or "TablePress Table" block is evaluated, so that CSS files are only loaded when needed.
154	*
155	* @since 3.0.0
156	*/
157	public function maybe_enqueue_css(): void {
158	// Bail early if the legacy CSS loading mechanism is used, as the files will then have been enqueued already.
159	if ( $this->use_legacy_css_loading && ! doing_action( 'enqueue_block_assets' ) ) {
160	return;
161	}
162
163	/*
164	* Bail early if the function is called from some action hook outside of the normal rendering process.
165	* These are often used by e.g. SEO plugins that render the content in additional contexts, e.g. to get an excerpt via an output buffer.
166	* In these cases, we don't want to enqueue the CSS, as it would likely not be printed on the page.
167	*/
168	if ( doing_action( 'wp_head' ) \|\| doing_action( 'wp_footer' ) ) {
169	return;
170	}
171
172	// Prevent repeated execution via a static variable.
173	static $css_enqueued = false;
174	if ( $css_enqueued && ! doing_action( 'enqueue_block_assets' ) ) {
175	return;
176	}
177	$css_enqueued = true;
178
179	$this->enqueue_css();
180	}
181
182	/**
183	* Enqueues CSS files for TablePress default CSS and "Custom CSS" (if desired).
184	*
185	* If styles have not been printed to the page (in the `<head>`), the TablePress CSS files will be enqueued.
186	* If styles have already been printed to the page, the TablePress CSS files will be printed right away (likely in the `<body`>).
187	*
188	* @since 1.0.0
189	*/
190	public function enqueue_css(): void {
191	/**
192	* Filters whether the TablePress Default CSS code shall be loaded.
193	*
194	* @since 1.0.0
195	*
196	* @param bool $use Whether the Default CSS shall be loaded. Default true.
197	*/
198	$use_default_css = apply_filters( 'tablepress_use_default_css', true );
199	$use_custom_css = TablePress::$model_options->get( 'use_custom_css' );
200
201	if ( ! $use_default_css && ! $use_custom_css ) {
202	// Register a placeholder dependency, so that the handle is known for other styles.
203	wp_register_style( 'tablepress-default', false ); // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion
204	return;
205	}
206
207	$custom_css = TablePress::$model_options->get( 'custom_css' );
208	$use_custom_css = $use_custom_css && '' !== $custom_css;
209	$use_custom_css_file = $use_custom_css && TablePress::$model_options->get( 'use_custom_css_file' );
210	/**
211	* Filters the "Custom CSS" version number that is appended to the enqueued CSS files
212	*
213	* @since 1.0.0
214	*
215	* @param int $version The "Custom CSS" version.
216	*/
217	$custom_css_version = (string) apply_filters( 'tablepress_custom_css_version', TablePress::$model_options->get( 'custom_css_version' ) );
218
219	$tablepress_css = TablePress::load_class( 'TablePress_CSS', 'class-css.php', 'classes' );
220
221	// Determine Default CSS URL.
222	$rtl = ( is_rtl() ) ? '-rtl' : '';
223	$unfiltered_default_css_url = plugins_url( "css/build/default{$rtl}.css", TABLEPRESS__FILE__ );
224	/**
225	* Filters the URL from which the TablePress Default CSS file is loaded.
226	*
227	* @since 1.0.0
228	*
229	* @param string $unfiltered_default_css_url URL of the TablePress Default CSS file.
230	*/
231	$default_css_url = apply_filters( 'tablepress_default_css_url', $unfiltered_default_css_url );
232
233	$use_custom_css_combined_file = ( $use_default_css && $use_custom_css_file && ! SCRIPT_DEBUG && ! is_rtl() && $unfiltered_default_css_url === $default_css_url && $tablepress_css->load_custom_css_from_file( 'combined' ) );
234
235	if ( $use_custom_css_combined_file ) {
236	$custom_css_combined_url = $tablepress_css->get_custom_css_location( 'combined', 'url' );
237	// Need to use 'tablepress-default' instead of 'tablepress-combined' to not break existing TablePress Extensions.
238	wp_enqueue_style( 'tablepress-default', $custom_css_combined_url, array(), $custom_css_version );
239	if ( did_action( 'wp_print_styles' ) ) {
240	wp_print_styles( 'tablepress-default' );
241	}
242	return;
243	}
244
245	if ( $use_default_css ) {
246	wp_enqueue_style( 'tablepress-default', $default_css_url, array(), TablePress::version );
247	} else {
248	// Register a placeholder dependency, so that the handle is known for other styles.
249	wp_register_style( 'tablepress-default', false ); // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion
250	}
251
252	$use_custom_css_minified_file = ( $use_custom_css_file && ! SCRIPT_DEBUG && $tablepress_css->load_custom_css_from_file( 'minified' ) );
253	if ( $use_custom_css_minified_file ) {
254	$custom_css_minified_url = $tablepress_css->get_custom_css_location( 'minified', 'url' );
255	wp_enqueue_style( 'tablepress-custom', $custom_css_minified_url, array( 'tablepress-default' ), $custom_css_version );
256	if ( did_action( 'wp_print_styles' ) ) {
257	wp_print_styles( 'tablepress-custom' );
258	}
259	return;
260	}
261
262	$use_custom_css_normal_file = ( $use_custom_css_file && $tablepress_css->load_custom_css_from_file( 'normal' ) );
263	if ( $use_custom_css_normal_file ) {
264	$custom_css_normal_url = $tablepress_css->get_custom_css_location( 'normal', 'url' );
265	wp_enqueue_style( 'tablepress-custom', $custom_css_normal_url, array( 'tablepress-default' ), $custom_css_version );
266	if ( did_action( 'wp_print_styles' ) ) {
267	wp_print_styles( 'tablepress-custom' );
268	}
269	return;
270	}
271
272	if ( $use_custom_css ) {
273	// Get "Custom CSS" from options, try minified Custom CSS first.
274	$custom_css_minified = TablePress::$model_options->get( 'custom_css_minified' );
275	if ( ! empty( $custom_css_minified ) ) {
276	$custom_css = $custom_css_minified;
277	}
278	/**
279	* Filters the "Custom CSS" code that is to be loaded as inline CSS.
280	*
281	* @since 1.0.0
282	*
283	* @param string $custom_css The "Custom CSS" code.
284	*/
285	$custom_css = apply_filters( 'tablepress_custom_css', $custom_css );
286	if ( ! empty( $custom_css ) ) {
287	wp_add_inline_style( 'tablepress-default', $custom_css );
288	if ( did_action( 'wp_print_styles' ) ) {
289	wp_print_styles( 'tablepress-default' );
290	}
291	return;
292	}
293	}
294	}
295
296	/**
297	* Enqueues the DataTables JavaScript library and its dependencies.
298	*
299	* @since 3.0.0
300	*/
301	protected function enqueue_datatables_files(): void {
302	$js_file = 'js/jquery.datatables.min.js';
303	$js_url = plugins_url( $js_file, TABLEPRESS__FILE__ );
304	/**
305	* Filters the URL from which the DataTables JavaScript library file is loaded.
306	*
307	* @since 1.0.0
308	*
309	* @param string $js_url URL of the DataTables JS library file.
310	* @param string $js_file Path and file name of the DataTables JS library file.
311	*/
312	$js_url = apply_filters( 'tablepress_datatables_js_url', $js_url, $js_file );
313
314	$dependencies = array( 'jquery-core' );
315	if ( ! empty( $this->datatables_datetime_formats ) ) {
316	$dependencies[] = 'moment';
317	}
318	/**
319	* Filters the dependencies for the DataTables JavaScript library.
320	*
321	* @since 3.0.0
322	*
323	* @param string[] $dependencies The dependencies for the DataTables JS library.
324	*/
325	$dependencies = apply_filters( 'tablepress_datatables_js_dependencies', $dependencies );
326
327	wp_enqueue_script( 'tablepress-datatables', $js_url, $dependencies, TablePress::version, true );
328	}
329
330	/**
331	* Adds the JavaScript code for the invocation of the DataTables JS library.
332	*
333	* @since 1.0.0
334	*/
335	public function add_datatables_calls(): void {
336	// Prevent repeated execution (which would lead to DataTables error messages) via a static variable.
337	static $datatables_calls_printed = false;
338	if ( $datatables_calls_printed ) {
339	return;
340	}
341
342	// Bail early if there are no TablePress tables on the page.
343	if ( empty( $this->shown_tables ) ) {
344	return;
345	}
346
347	/*
348	* Don't add the DataTables function calls in the scope of the block editor iframe.
349	* This is necessary for non-block themes, for others, the repeated execution check above is sufficient.
350	*/
351	if ( function_exists( 'get_current_screen' ) ) {
352	$current_screen = get_current_screen();
353	if ( ( $current_screen instanceof WP_Screen ) && $current_screen->is_block_editor() ) {
354	return;
355	}
356	}
357
358	// Filter out all tables that use DataTables.
359	$shown_tables_with_datatables = array();
360	foreach ( $this->shown_tables as $table_id => $table_store ) {
361	if ( ! empty( $table_store['instances'] ) ) {
362	$shown_tables_with_datatables[ (string) $table_id ] = $table_store;
363	}
364	}
365
366	// Bail early if there are no tables with activated DataTables on the page.
367	if ( empty( $shown_tables_with_datatables ) ) {
368	return;
369	}
370
371	$this->enqueue_datatables_files();
372
373	// Storage for the DataTables language strings.
374	$datatables_language = array();
375	// Generate the specific JS commands, depending on chosen features on the "Edit" screen and the Shortcode parameters.
376	$commands = array();
377
378	foreach ( $shown_tables_with_datatables as $table_id => $table_store ) {
379	$table_id = (string) $table_id; // Ensure that the table ID is a string, as it comes from an array key where numeric strings are converted to integers.
380
381	foreach ( $table_store['instances'] as $html_id => $js_options ) {
382	$parameters = array();
383
384	// Settle dependencies/conflicts between certain features.
385	if ( false !== $js_options['datatables_scrolly'] ) { // datatables_scrolly can be a string, so that the explicit `false` check is needed.
386	// Vertical scrolling and pagination don't work together.
387	$js_options['datatables_paginate'] = false;
388	}
389	// Sanitize, as it may come from a Shortcode attribute.
390	$js_options['datatables_paginate_entries'] = (int) $js_options['datatables_paginate_entries'];
391
392	/*
393	* DataTables language/translation handling.
394	*/
395
396	/**
397	* Filters the locale/language for the DataTables JavaScript library.
398	*
399	* @since 1.0.0
400	*
401	* @param string $locale The DataTables JS library locale.
402	* @param string $table_id The current table ID.
403	*/
404	$datatables_locale = apply_filters( 'tablepress_datatables_locale', $js_options['datatables_locale'], $table_id );
405
406	// Only load each locale's language file once.
407	if ( ! isset( $datatables_language[ $datatables_locale ] ) ) {
408	$orig_language_file = TABLEPRESS_ABSPATH . "i18n/datatables/lang-{$datatables_locale}.php";
409
410	/**
411	* Filters the language file path for the DataTables JavaScript library.
412	*
413	* PHP files that return an array and JSON files are supported.
414	* The JSON file method is deprecated and should no longer be used.
415	*
416	* @since 1.0.0
417	*
418	* @param string $orig_language_file Language file path for the DataTables JS library.
419	* @param string $datatables_locale Current locale/language for the DataTables JS library.
420	* @param string $tablepress_abspath Base path of the TablePress plugin.
421	*/
422	$language_file = apply_filters( 'tablepress_datatables_language_file', $orig_language_file, $datatables_locale, TABLEPRESS_ABSPATH );
423
424	/*
425	* Load translation file if it's not "en_US" (included as the default in DataTables)
426	* or if the filter was used to change the language file, and the language file exists.
427	* Otherwise, use an empty en_US placeholder, so that the strings are filterable later.
428	*/
429	if ( ( 'en_US' !== $datatables_locale \|\| $orig_language_file !== $language_file ) && file_exists( $language_file ) ) {
430	if ( str_ends_with( $language_file, '.php' ) ) {
431	$datatables_strings = require $language_file;
432	if ( ! is_array( $datatables_strings ) ) {
433	$datatables_strings = array();
434	}
435	} elseif ( str_ends_with( $language_file, '.json' ) ) {
436	$datatables_strings = file_get_contents( $language_file );
437	$datatables_strings = json_decode( $datatables_strings, true ); // @phpstan-ignore argument.type
438	// Check if JSON could be decoded.
439	if ( is_null( $datatables_strings ) ) {
440	$datatables_strings = array();
441	}
442	$datatables_strings = (array) $datatables_strings;
443	} else {
444	// The filtered language file exists, but is not a .php or .json file, so don't use it.
445	$datatables_strings = array();
446	}
447	} else {
448	// If no translation file for the defined locale exists or is needed, use "en_US", as that's built-in.
449	$datatables_locale = 'en_US';
450	$datatables_strings = array();
451	}
452
453	/**
454	* Filters the language strings for the DataTables JavaScript library's features.
455	*
456	* @since 2.0.0
457	*
458	* @param array<string, mixed> $datatables_strings The language strings for DataTables.
459	* @param string $datatables_locale Current locale/language for the DataTables JS library.
460	*/
461	$datatables_language[ $datatables_locale ] = apply_filters( 'tablepress_datatables_language_strings', $datatables_strings, $datatables_locale );
462	}
463	$parameters['language'] = "language:DT_language['{$datatables_locale}']";
464
465	// These parameters need to be added for performance gain or to overwrite unwanted default behavior.
466	if ( $js_options['datatables_sort'] ) {
467	// No initial sort.
468	$parameters['order'] = 'order:[]';
469	// Don't add additional classes, to speed up sorting.
470	$parameters['orderClasses'] = 'orderClasses:false';
471	}
472
473	// The following options are activated by default, so we only need to "false" them if we don't want them, but don't need to "true" them if we do.
474	if ( ! $js_options['datatables_sort'] ) {
475	$parameters['ordering'] = 'ordering:false';
476	}
477	if ( $js_options['datatables_paginate'] ) {
478	$parameters['pagingType'] = "pagingType:'simple_numbers'";
479	if ( $js_options['datatables_lengthchange'] ) {
480	$length_menu = array( 10, 25, 50, 100 );
481	if ( ! in_array( $js_options['datatables_paginate_entries'], $length_menu, true ) ) {
482	$length_menu[] = $js_options['datatables_paginate_entries'];
483	sort( $length_menu, SORT_NUMERIC );
484	$parameters['lengthMenu'] = 'lengthMenu:[' . implode( ',', $length_menu ) . ']';
485	}
486	} else {
487	$parameters['lengthChange'] = 'lengthChange:false';
488	}
489	if ( 10 !== $js_options['datatables_paginate_entries'] ) {
490	$parameters['pageLength'] = "pageLength:{$js_options['datatables_paginate_entries']}";
491	}
492	} else {
493	$parameters['paging'] = 'paging:false';
494	}
495	if ( ! $js_options['datatables_filter'] ) {
496	$parameters['searching'] = 'searching:false';
497	}
498	if ( ! $js_options['datatables_info'] ) {
499	$parameters['info'] = 'info:false';
500	}
501	if ( $js_options['datatables_scrollx'] ) {
502	$parameters['scrollX'] = 'scrollX:true';
503	}
504	if ( false !== $js_options['datatables_scrolly'] ) {
505	$parameters['scrollY'] = 'scrollY:"' . preg_replace( '#[^0-9a-z.%]#', '', $js_options['datatables_scrolly'] ) . '"';
506	$parameters['scrollCollapse'] = 'scrollCollapse:true';
507	}
508	if ( '' !== $js_options['datatables_custom_commands'] ) {
509	$parameters['custom_commands'] = trim( $js_options['datatables_custom_commands'] ); // Remove leading and trailing whitespace.
510	$parameters['custom_commands'] = trim( $parameters['custom_commands'], ',' ); // Remove potentially leading and trailing commas to prevent JS script errors.
511	}
512
513	/**
514	* Filters the parameters that are passed to the DataTables JavaScript library.
515	*
516	* @since 1.0.0
517	*
518	* @param array<string, mixed> $parameters The parameters for the DataTables JS library.
519	* @param string $table_id The current table ID.
520	* @param string $html_id The ID of the table HTML element.
521	* @param array<string, mixed> $js_options The options for the JS library.
522	*/
523	$parameters = apply_filters( 'tablepress_datatables_parameters', $parameters, $table_id, $html_id, $js_options );
524
525	// If an existing parameter is set as an object key in the "Custom Commands", remove its separate value, to allow for full overrides.
526	if ( isset( $parameters['custom_commands'] ) && '' !== $parameters['custom_commands'] ) {
527	$parameters_in_custom_commands = TablePress::extract_keys_from_js_object_string( '{' . $parameters['custom_commands'] . '}' );
528	foreach ( $parameters_in_custom_commands as $parameter_in_custom_commands ) {
529	unset( $parameters[ $parameter_in_custom_commands ] );
530	}
531	}
532
533	$name = substr( $html_id, 11 ); // Remove "tablepress-" from the HTML ID.
534	$name = "DT_TP['" . str_replace( '-', '_', $name ) . "']";
535	$parameters = implode( ',', $parameters );
536	$parameters = ( ! empty( $parameters ) ) ? '{' . $parameters . '}' : '';
537
538	$command = "{$name} = new DataTable('#{$html_id}',{$parameters});";
539	/**
540	* Filters the JavaScript command that invokes the DataTables JavaScript library on one table.
541	*
542	* @since 1.0.0
543	*
544	* @param string $command The JS command for the DataTables JS library.
545	* @param string $html_id The ID of the table HTML element.
546	* @param string $parameters The parameters for the DataTables JS library.
547	* @param string $table_id The current table ID.
548	* @param array<string, mixed> $js_options The options for the JS library.
549	* @param string $name The name of the DataTable instance.
550	*/
551	$command = apply_filters( 'tablepress_datatables_command', $command, $html_id, $parameters, $table_id, $js_options, $name );
552	if ( ! empty( $command ) ) {
553	$commands[] = $command;
554	}
555	} // foreach table instance
556	} // foreach table ID
557
558	// DataTables language/translation handling.
559	if ( ! empty( $datatables_language ) ) {
560	$datatables_language_command = wp_json_encode( $datatables_language, JSON_HEX_TAG \| JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE \| JSON_FORCE_OBJECT );
561	$datatables_language_command = "var DT_language={$datatables_language_command};\n";
562	} else {
563	$datatables_language_command = '';
564	}
565
566	// DataTables datetime format string handling.
567	if ( ! empty( $this->datatables_datetime_formats ) ) {
568	// Create a command like `DataTable.datetime('MM/DD/YYYY');DataTable.datetime('DD.MM.YYYY');`.
569	$datatables_datetime_command = implode(
570	'',
571	array_map(
572	static fn( string $datetime_format ): string => "DataTable.datetime('{$datetime_format}');",
573	$this->datatables_datetime_formats,
574	)
575	) . "\n";
576	} else {
577	$datatables_datetime_command = '';
578	}
579
580	/**
581	* Filters the JavaScript code for the DataTables JavaScript library that initializes the automatically detected date/time formats via moment.js.
582	*
583	* @since 3.0.0
584	*
585	* @param string $datatables_datetime_command The JS code for the DataTables JS library that initializes the date/time formats.
586	* @param string[] $datatables_datetime_formats The date/time formats for moment.js.
587	*/
588	$datatables_datetime_command = apply_filters( 'tablepress_datatables_datetime_command', $datatables_datetime_command, $this->datatables_datetime_formats );
589
590	$datatables_pre_commands = $datatables_language_command . $datatables_datetime_command;
591
592	$commands = implode( "\n", $commands );
593	/**
594	* Filters the JavaScript commands that invoke the DataTables JavaScript library on all tables on the page.
595	*
596	* @since 1.0.0
597	*
598	* @param string $commands The JS commands for the DataTables JS library.
599	*/
600	$commands = apply_filters( 'tablepress_all_datatables_commands', $commands );
601	if ( '' === $commands ) {
602	return;
603	}
604
605	$script_template = <<<'JS'
606	var DT_TP = {};
607	jQuery(($)=>{
608	%1$s%2$s
609	});
610	JS;
611	/**
612	* Filters the script/jQuery wrapper code for the DataTables commands calls.
613	*
614	* @since 1.14.0
615	*
616	* @param string $script_template Default script/jQuery wrapper code for the DataTables commands calls.
617	*/
618	$script_template = apply_filters( 'tablepress_all_datatables_commands_wrapper', $script_template );
619
620	$script = sprintf( $script_template, $datatables_pre_commands, $commands );
621	wp_add_inline_script( 'tablepress-datatables', $script );
622
623	// Prevent repeated execution (which would lead to DataTables error messages) via a static variable.
624	$datatables_calls_printed = true;
625	}
626
627	/**
628	* Handles the Shortcode [table id=<ID> /].
629	*
630	* @since 1.0.0
631	*
632	* @param array<string, mixed>\|string $shortcode_atts List of attributes that where included in the Shortcode. An empty string for empty Shortcodes like [table] or [table /].
633	* @return string Resulting HTML code for the table with the ID <ID>.
634	*/
635	public function shortcode_table( /* array\|string */ $shortcode_atts ): string {
636	$shortcode_atts = (array) $shortcode_atts;
637
638	$this->maybe_enqueue_css();
639
640	$_render = TablePress::load_class( 'TablePress_Render', 'class-render.php', 'classes' );
641
642	$default_shortcode_atts = $_render->get_default_render_options();
643	/**
644	* Filters the available/default attributes for the [table] Shortcode.
645	*
646	* @since 1.0.0
647	*
648	* @param array<string, mixed> $default_shortcode_atts The [table] Shortcode default attributes.
649	*/
650	$default_shortcode_atts = apply_filters( 'tablepress_shortcode_table_default_shortcode_atts', $default_shortcode_atts );
651	// Parse Shortcode attributes, only allow those that are specified.
652	$shortcode_atts = shortcode_atts( $default_shortcode_atts, $shortcode_atts ); // Optional third argument left out on purpose. Use filter in the next line instead.
653	/**
654	* Filters the attributes that were passed to the [table] Shortcode.
655	*
656	* @since 1.0.0
657	*
658	* @param array<string, mixed> $shortcode_atts The attributes passed to the [table] Shortcode.
659	*/
660	$shortcode_atts = apply_filters( 'tablepress_shortcode_table_shortcode_atts', $shortcode_atts );
661
662	// Check, if a table with the given ID exists.
663	$table_id = (string) preg_replace( '/[^a-zA-Z0-9_-]/', '', $shortcode_atts['id'] );
664	if ( ! TablePress::$model_table->table_exists( $table_id ) ) {
665	$message = "[table “{$table_id}” not found /]<br />\n";
666	/**
667	* Filters the "Table not found" message.
668	*
669	* @since 1.0.0
670	*
671	* @param string $message The "Table not found" message.
672	* @param string $table_id The current table ID.
673	*/
674	$message = apply_filters( 'tablepress_table_not_found_message', $message, $table_id );
675	return $message;
676	}
677
678	// Load table, with table data, options, and visibility settings.
679	$table = TablePress::$model_table->load( $table_id, true, true );
680	if ( is_wp_error( $table ) ) {
681	$message = "[table “{$table_id}” could not be loaded /]<br />\n";
682	/**
683	* Filters the "Table could not be loaded" message.
684	*
685	* @since 1.0.0
686	*
687	* @param string $message The "Table could not be loaded" message.
688	* @param string $table_id The current table ID.
689	* @param WP_Error $table The error object for the table.
690	*/
691	$message = apply_filters( 'tablepress_table_load_error_message', $message, $table_id, $table );
692	return $message;
693	}
694	if ( isset( $table['is_corrupted'] ) && $table['is_corrupted'] ) {
695	$message = "<div>Attention: The internal data of table “{$table_id}” is corrupted!</div>";
696	/**
697	* Filters the "Table data is corrupted" message.
698	*
699	* @since 1.0.0
700	*
701	* @param string $message The "Table data is corrupted" message.
702	* @param string $table_id The current table ID.
703	* @param string $json_error The JSON error with information about the corrupted table.
704	*/
705	$message = apply_filters( 'tablepress_table_corrupted_message', $message, $table_id, $table['json_error'] );
706	return $message;
707	}
708
709	if ( ! is_null( $shortcode_atts['datatables_custom_commands'] ) ) {
710	/**
711	* Filters whether the "datatables_custom_commands" Shortcode parameter is disabled.
712	*
713	* By default, the "datatables_custom_commands" Shortcode parameter is disabled for security reasons.
714	*
715	* @since 1.0.0
716	*
717	* @param bool $disable Whether to disable the "datatables_custom_commands" Shortcode parameter. Default true.
718	*/
719	if ( apply_filters( 'tablepress_disable_custom_commands_shortcode_parameter', true ) ) {
720	$shortcode_atts['datatables_custom_commands'] = null;
721	} else {
722	// Convert the HTML entity `&` back to `&` manually, as entities in Shortcodes in normal text paragraphs are sometimes double-encoded.
723	$shortcode_atts['datatables_custom_commands'] = str_replace( '&', '&', $shortcode_atts['datatables_custom_commands'] );
724	// Convert HTML entities like `<`, `[`, `[`, and `&` back to their respective characters.
725	$shortcode_atts['datatables_custom_commands'] = html_entity_decode( $shortcode_atts['datatables_custom_commands'], ENT_QUOTES \| ENT_HTML5, get_option( 'blog_charset' ) );
726	}
727	}
728
729	// Determine options to use (if set in Shortcode, use those, otherwise use stored options, from the "Edit" screen).
730	$render_options = array();
731	foreach ( $shortcode_atts as $key => $value ) {
732	if ( is_null( $value ) && isset( $table['options'][ $key ] ) ) {
733	// Use the table's stored option value, if the Shortcode parameter was not set.
734	$render_options[ $key ] = $table['options'][ $key ];
735	} elseif ( is_string( $value ) ) {
736	// Convert strings 'true' or 'false' to boolean, keep others.
737	$value_lowercase = strtolower( $value );
738	if ( 'true' === $value_lowercase ) {
739	$render_options[ $key ] = true;
740	} elseif ( 'false' === $value_lowercase ) {
741	$render_options[ $key ] = false;
742	} else {
743	$render_options[ $key ] = $value;
744	}
745	} else {
746	// Keep all other values.
747	$render_options[ $key ] = $value;
748	}
749	}
750
751	// Backward compatibility: Convert boolean or numeric string "table_head" and "table_foot" options to integer.
752	$render_options['table_head'] = absint( $render_options['table_head'] );
753	$render_options['table_foot'] = absint( $render_options['table_foot'] );
754
755	// Generate unique HTML ID, depending on how often this table has already been shown on this page.
756	if ( ! isset( $this->shown_tables[ $table_id ] ) ) {
757	$this->shown_tables[ $table_id ] = array(
758	'count' => 0,
759	'instances' => array(),
760	);
761	}
762	++$this->shown_tables[ $table_id ]['count'];
763	$count = $this->shown_tables[ $table_id ]['count'];
764	$render_options['html_id'] = "tablepress-{$table_id}";
765	if ( $count > 1 ) {
766	$render_options['html_id'] .= "-no-{$count}";
767	}
768	/**
769	* Filters the ID of the table HTML element.
770	*
771	* @since 1.0.0
772	*
773	* @param string $html_id The ID of the table HTML element.
774	* @param string $table_id The current table ID.
775	* @param int $count Number of copies of the table with this table ID on the page.
776	*/
777	$render_options['html_id'] = apply_filters( 'tablepress_html_id', $render_options['html_id'], $table_id, $count );
778
779	// Generate the "Edit Table" link.
780	$render_options['edit_table_url'] = '';
781	/**
782	* Filters whether the "Edit" link below the table shall be shown.
783	*
784	* The "Edit" link is only shown to logged-in users who possess the necessary capability to edit the table.
785	*
786	* @since 1.0.0
787	*
788	* @param bool $show Whether to show the "Edit" link below the table. Default true.
789	* @param string $table_id The current table ID.
790	*/
791	if ( is_user_logged_in() && ! $render_options['block_preview'] && apply_filters( 'tablepress_edit_link_below_table', true, $table['id'] ) && current_user_can( 'tablepress_edit_table', $table['id'] ) ) {
792	$render_options['edit_table_url'] = TablePress::url( array( 'action' => 'edit', 'table_id' => $table['id'] ) );
793	}
794
795	/**
796	* Filters the render options for the table.
797	*
798	* The render options are determined from the settings on a table's "Edit" screen and the Shortcode parameters.
799	*
800	* @since 1.0.0
801	*
802	* @param array<string, mixed> $render_options The render options for the table.
803	* @param array<string, mixed> $table The current table.
804	*/
805	$render_options = apply_filters( 'tablepress_table_render_options', $render_options, $table );
806
807	// Backward compatibility: Convert boolean "table_head" and "table_foot" options to integer, in case they were overwritten via the filter hook.
808	$render_options['table_head'] = absint( $render_options['table_head'] );
809	$render_options['table_foot'] = absint( $render_options['table_foot'] );
810
811	// Check if table output shall and can be loaded from the transient cache, otherwise generate the output.
812	if ( $render_options['cache_table_output'] && ! is_user_logged_in() ) {
813	// Hash the Render Options array to get a unique cache identifier.
814	$table_hash = md5( wp_json_encode( $render_options, TABLEPRESS_JSON_OPTIONS ) ); // @phpstan-ignore argument.type
815	$transient_name = 'tablepress_' . $table_hash; // Attention: This string must not be longer than 45 characters!
816	$output = get_transient( $transient_name );
817	if ( false === $output \|\| '' === $output ) {
818	// Render/generate the table HTML, as it was not found in the cache.
819	$_render->set_input( $table, $render_options );
820	$output = $_render->get_output( 'html' );
821	// Save render output in a transient, set cache timeout to 24 hours.
822	set_transient( $transient_name, $output, DAY_IN_SECONDS );
823	// Update output caches list transient (necessary for cache invalidation upon table saving).
824	$caches_list_transient_name = 'tablepress_c_' . md5( $table_id );
825	$caches_list = get_transient( $caches_list_transient_name );
826	if ( false === $caches_list ) {
827	$caches_list = array();
828	} else {
829	$caches_list = (array) json_decode( $caches_list, true );
830	}
831	if ( ! in_array( $transient_name, $caches_list, true ) ) {
832	$caches_list[] = $transient_name;
833	}
834	set_transient( $caches_list_transient_name, wp_json_encode( $caches_list, TABLEPRESS_JSON_OPTIONS ), 2 * DAY_IN_SECONDS );
835	} else {
836	/**
837	* Filters the cache hit comment message.
838	*
839	* @since 1.0.0
840	*
841	* @param string $comment The cache hit comment message.
842	*/
843	$output .= apply_filters( 'tablepress_cache_hit_comment', "<!-- #{$render_options['html_id']} from cache -->" );
844	}
845	} else {
846	// Render/generate the table HTML, as no cache is to be used.
847	$_render->set_input( $table, $render_options );
848	$output = $_render->get_output( 'html' );
849	}
850
851	// If DataTables is to be and can be used with this instance of a table, process its parameters and register the call for inclusion in the footer.
852	if ( $render_options['use_datatables']
853	&& 0 < $render_options['table_head']
854	&& ! str_contains( $output, 'tbody-has-connected-cells' ) // The Render class adds this CSS class to the `<table>` element if the table has connected cells in the `<tbody>`.
855	) {
856	// Get options for the DataTables JavaScript library from the table's render options.
857	$js_options = array();
858	foreach ( array(
859	'alternating_row_colors',
860	'datatables_sort',
861	'datatables_paginate',
862	'datatables_paginate',
863	'datatables_paginate_entries',
864	'datatables_lengthchange',
865	'datatables_filter',
866	'datatables_info',
867	'datatables_scrollx',
868	'datatables_scrolly',
869	'datatables_locale',
870	'datatables_custom_commands',
871	) as $option ) {
872	$js_options[ $option ] = $render_options[ $option ];
873	}
874	/**
875	* Filters the JavaScript options for the table.
876	*
877	* The JavaScript options are determined from the settings on a table's "Edit" screen and the Shortcode parameters.
878	* They are part of the render options and can be overwritten with Shortcode parameters.
879	*
880	* @since 1.0.0
881	*
882	* @param array<string, mixed> $js_options The JavaScript options for the table.
883	* @param string $table_id The current table ID.
884	* @param array<string, mixed> $render_options The render options for the table.
885	*/
886	$js_options = apply_filters( 'tablepress_table_js_options', $js_options, $table_id, $render_options );
887
888	$this->shown_tables[ $table_id ]['instances'][ (string) $render_options['html_id'] ] = $js_options;
889
890	// DataTables datetime format string handling.
891	if ( '' !== $render_options['datatables_datetime'] ) {
892	$render_options['datatables_datetime'] = explode( '\|', $render_options['datatables_datetime'] );
893	foreach ( $render_options['datatables_datetime'] as $datetime_format ) {
894	$datetime_format = trim( $datetime_format );
895	if ( '' !== $datetime_format && ! in_array( $datetime_format, $this->datatables_datetime_formats, true ) ) {
896	$this->datatables_datetime_formats[] = $datetime_format;
897	}
898	}
899	}
900	}
901
902	// Maybe print a list of used render options.
903	if ( $render_options['shortcode_debug'] && is_user_logged_in() ) {
904	$output .= '<pre>' . var_export( $render_options, true ) . '</pre>'; // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
905	}
906
907	return $output;
908	}
909
910	/**
911	* Handles the Shortcode [table-info id=<ID> field=<name> /].
912	*
913	* @since 1.0.0
914	*
915	* @param array<string, mixed>\|string $shortcode_atts List of attributes that where included in the Shortcode. An empty string for empty Shortcodes like [table] or [table /].
916	* @return string Text that replaces the Shortcode (error message or asked-for information).
917	*/
918	public function shortcode_table_info( /* array\|string */ $shortcode_atts ): string {
919	$shortcode_atts = (array) $shortcode_atts;
920
921	// Parse Shortcode attributes, only allow those that are specified.
922	$default_shortcode_atts = array(
923	'id' => '',
924	'field' => '',
925	'format' => '',
926	);
927	/**
928	* Filters the available/default attributes for the [table-info] Shortcode.
929	*
930	* @since 1.0.0
931	*
932	* @param array<string, mixed> $default_shortcode_atts The [table-info] Shortcode default attributes.
933	*/
934	$default_shortcode_atts = apply_filters( 'tablepress_shortcode_table_info_default_shortcode_atts', $default_shortcode_atts );
935	$shortcode_atts = shortcode_atts( $default_shortcode_atts, $shortcode_atts ); // Optional third argument left out on purpose. Use filter in the next line instead.
936	/**
937	* Filters the attributes that were passed to the [table-info] Shortcode.
938	*
939	* @since 1.0.0
940	*
941	* @param array<string, mixed> $shortcode_atts The attributes passed to the [table-info] Shortcode.
942	*/
943	$shortcode_atts = apply_filters( 'tablepress_shortcode_table_info_shortcode_atts', $shortcode_atts );
944
945	/**
946	* Filters whether the output of the [table-info] Shortcode is overwritten/short-circuited.
947	*
948	* @since 1.0.0
949	*
950	* @param false\|string $overwrite Whether the [table-info] output is overwritten. Return false for the regular content, and a string to overwrite the output.
951	* @param array<string, mixed> $shortcode_atts The attributes passed to the [table-info] Shortcode.
952	*/
953	$overwrite = apply_filters( 'tablepress_shortcode_table_info_overwrite', false, $shortcode_atts );
954	if ( is_string( $overwrite ) ) {
955	return $overwrite;
956	}
957
958	// Check, if a table with the given ID exists.
959	$table_id = preg_replace( '/[^a-zA-Z0-9_-]/', '', $shortcode_atts['id'] );
960	if ( ! TablePress::$model_table->table_exists( $table_id ) ) {
961	$message = "[table “{$table_id}” not found /]<br />\n";
962	/** This filter is documented in controllers/controller-frontend.php */
963	$message = apply_filters( 'tablepress_table_not_found_message', $message, $table_id );
964	return $message;
965	}
966
967	// Load table, with table data, options, and visibility settings.
968	$table = TablePress::$model_table->load( $table_id, true, true );
969	if ( is_wp_error( $table ) ) {
970	$message = "[table “{$table_id}” could not be loaded /]<br />\n";
971	/** This filter is documented in controllers/controller-frontend.php */
972	$message = apply_filters( 'tablepress_table_load_error_message', $message, $table_id, $table );
973	return $message;
974	}
975
976	$field = (string) preg_replace( '/[^a-z_]/', '', strtolower( $shortcode_atts['field'] ) );
977	$format = (string) preg_replace( '/[^a-z]/', '', strtolower( $shortcode_atts['format'] ) );
978
979	// Generate output, depending on what information (field) was asked for.
980	switch ( $field ) {
981	case 'name':
982	case 'description':
983	$output = $table[ $field ];
984	break;
985	case 'last_modified':
986	switch ( $format ) {
987	case 'raw':
988	case 'mysql':
989	$output = $table['last_modified'];
990	break;
991	case 'human':
992	$modified_timestamp = date_create( $table['last_modified'], wp_timezone() );
993	if ( false === $modified_timestamp ) {
994	$modified_timestamp = $table['last_modified'];
995	} else {
996	$modified_timestamp = $modified_timestamp->getTimestamp();
997	}
998	$current_timestamp = time();
999	$time_diff = $current_timestamp - $modified_timestamp;
1000	// Time difference is only shown up to one week.
1001	if ( $time_diff >= 0 && $time_diff < WEEK_IN_SECONDS ) {
1002	$output = sprintf( __( '%s ago', 'default' ), human_time_diff( $modified_timestamp, $current_timestamp ) );
1003	} else {
1004	$output = TablePress::format_datetime( $table['last_modified'], '<br />' );
1005	}
1006	break;
1007	case 'date':
1008	$output = TablePress::format_datetime( $table['last_modified'], get_option( 'date_format' ) );
1009	break;
1010	case 'time':
1011	$output = TablePress::format_datetime( $table['last_modified'], get_option( 'time_format' ) );
1012	break;
1013	default:
1014	$output = TablePress::format_datetime( $table['last_modified'] );
1015	break;
1016	}
1017	break;
1018	case 'last_editor':
1019	$output = TablePress::get_user_display_name( $table['options']['last_editor'] );
1020	break;
1021	case 'author':
1022	$output = TablePress::get_user_display_name( $table['author'] );
1023	break;
1024	case 'number_rows':
1025	$output = count( $table['data'] );
1026	if ( 'raw' !== $format ) {
1027	$output -= $table['options']['table_head'];
1028	$output -= $table['options']['table_foot'];
1029	}
1030	break;
1031	case 'number_columns':
1032	$output = count( $table['data'][0] );
1033	break;
1034	default:
1035	$output = "[table-info field “{$field}” not found in table “{$table_id}” /]<br />\n";
1036	/**
1037	* Filters the "table info field not found" message.
1038	*
1039	* @since 1.0.0
1040	*
1041	* @param string $output The "table info field not found" message.
1042	* @param array<string, mixed> $table The current table.
1043	* @param string $field The field that was not found.
1044	* @param string $format The return format for the field.
1045	*/
1046	$output = apply_filters( 'tablepress_table_info_not_found_message', $output, $table, $field, $format );
1047	}
1048
1049	/**
1050	* Filters the output of the [table-info] Shortcode.
1051	*
1052	* @since 1.0.0
1053	*
1054	* @param string $output The output of the [table-info] Shortcode.
1055	* @param array<string, mixed> $table The current table.
1056	* @param array<string, mixed> $shortcode_atts The attributes passed to the [table-info] Shortcode.
1057	*/
1058	$output = apply_filters( 'tablepress_shortcode_table_info_output', $output, $table, $shortcode_atts );
1059	return $output;
1060	}
1061
1062	/**
1063	* Expands the WP Search to also find posts and pages that have a search term in a table that is shown in them.
1064	*
1065	* This is done by looping through all search terms and TablePress tables and searching there for the search term,
1066	* saving all tables's IDs that have a search term and then expanding the WP query to search for posts or pages that have the
1067	* Shortcode for one of these tables in their content.
1068	*
1069	* @since 1.0.0
1070	*
1071	* @global wpdb $wpdb WordPress database abstraction object.
1072	*
1073	* @param string $search_sql Current part of the "WHERE" clause of the SQL statement used to get posts/pages from the WP database that is related to searching.
1074	* @return string Eventually extended SQL "WHERE" clause, to also find posts/pages with Shortcodes in them.
1075	*/
1076	public function posts_search_filter( /* string */ $search_sql ): string {
1077	// Don't use a type hint in the method declaration as there can be cases where `null` is passed to the filter hook callback somehow.
1078
1079	global $wpdb;
1080
1081	// Protect against cases where `null` is somehow passed to the filter hook callback.
1082	if ( ! is_string( $search_sql ) ) { // @phpstan-ignore function.alreadyNarrowedType (The `is_string()` check is needed as the input is coming from a filter hook.)
1083	return '';
1084	}
1085
1086	if ( ! is_search() \|\| ! is_main_query() ) {
1087	return $search_sql;
1088	}
1089
1090	// Get variable that contains all search terms, parsed from $_GET['s'] by WP.
1091	$search_terms = get_query_var( 'search_terms' );
1092	if ( empty( $search_terms ) \|\| ! is_array( $search_terms ) ) {
1093	return $search_sql;
1094	}
1095
1096	// Load all table IDs and prime post meta cache for cached access to options and visibility settings of the tables, don't run filter hook.
1097	$table_ids = TablePress::$model_table->load_all( true, false );
1098	// Array of all search words that were found, and the table IDs where they were found.
1099	$query_result = array();
1100
1101	$fn_stripos = function_exists( 'mb_stripos' ) ? 'mb_stripos' : 'stripos';
1102
1103	foreach ( $table_ids as $table_id ) {
1104	// Load table, with table data, options, and visibility settings.
1105	$table = TablePress::$model_table->load( $table_id, true, true );
1106
1107	// Skip tables that could not be loaded.
1108	if ( is_wp_error( $table ) ) {
1109	continue;
1110	}
1111
1112	// Do not search in corrupted tables.
1113	if ( isset( $table['is_corrupted'] ) && $table['is_corrupted'] ) {
1114	continue;
1115	}
1116
1117	foreach ( $search_terms as $search_term ) {
1118	if ( ( $table['options']['print_name'] && false !== $fn_stripos( $table['name'], (string) $search_term ) )
1119	\|\| ( $table['options']['print_description'] && false !== $fn_stripos( $table['description'], (string) $search_term ) ) ) {
1120	// Found the search term in the name or description (and they are shown).
1121	$query_result[ $search_term ][] = $table_id; // Add table ID to result list.
1122	// No need to continue searching this search term in this table.
1123	continue;
1124	}
1125
1126	// Search search term in visible table cells (without taking Shortcode parameters into account!).
1127	foreach ( $table['data'] as $row_idx => $table_row ) {
1128	if ( 0 === $table['visibility']['rows'][ $row_idx ] ) {
1129	// Row is hidden, so don't search in it.
1130	continue;
1131	}
1132	foreach ( $table_row as $col_idx => $table_cell ) {
1133	if ( 0 === $table['visibility']['columns'][ $col_idx ] ) {
1134	// Column is hidden, so don't search in it.
1135	continue;
1136	}
1137	// @todo Cells are not evaluated here, so math formulas are searched.
1138	if ( false !== $fn_stripos( $table_cell, (string) $search_term ) ) {
1139	// Found the search term in the cell content.
1140	$query_result[ $search_term ][] = $table_id; // Add table ID to result list
1141	// No need to continue searching this search term in this table.
1142	continue 3;
1143	}
1144	}
1145	}
1146	}
1147	}
1148
1149	// For all found table IDs for each search term, add additional OR statement to the SQL "WHERE" clause.
1150
1151	// If $_GET['exact'] is set, WordPress doesn't use % in SQL LIKE clauses.
1152	$exact = get_query_var( 'exact' );
1153	$n = ( empty( $exact ) ) ? '%' : '';
1154	$search_sql = $wpdb->remove_placeholder_escape( $search_sql );
1155	foreach ( $query_result as $search_term => $table_ids ) {
1156	$search_term = esc_sql( $wpdb->esc_like( $search_term ) );
1157	$old_or = "OR ({$wpdb->posts}.post_content LIKE '{$n}{$search_term}{$n}')"; // @phpstan-ignore encapsedStringPart.nonString (The esc_sql() call above returns a string, as a string is passed.)
1158	$table_ids = implode( '\|', $table_ids );
1159	$regexp = '\\\\[' . TablePress::$shortcode . ' id=(["\\\']?)(' . $table_ids . ')([\]"\\\' /])'; // ' needs to be single escaped, [ double escaped (with \\) in mySQL
1160	$new_or = $old_or . " OR ({$wpdb->posts}.post_content REGEXP '{$regexp}')";
1161	$search_sql = str_replace( $old_or, $new_or, $search_sql );
1162	}
1163	$search_sql = $wpdb->add_placeholder_escape( $search_sql );
1164
1165	return $search_sql;
1166	}
1167
1168	/**
1169	* Callback function for rendering the tablepress/table block.
1170	*
1171	* @since 2.0.0
1172	*
1173	* @param array<string, string> $block_attributes List of attributes that where included in the block settings.
1174	* @return string Resulting HTML code for the table.
1175	*/
1176	public function table_block_render_callback( array $block_attributes ): string {
1177	// Don't return anything if no table was selected.
1178	if ( '' === $block_attributes['id'] ) {
1179	return '';
1180	}
1181
1182	if ( '' !== trim( $block_attributes['parameters'] ) ) {
1183	$render_attributes = shortcode_parse_atts( $block_attributes['parameters'] );
1184	} else {
1185	$render_attributes = array();
1186	}
1187	$render_attributes['id'] = $block_attributes['id'];
1188
1189	return $this->shortcode_table( $render_attributes );
1190	}
1191
1192	/**
1193	* Registers the TablePress Elementor widgets.
1194	*
1195	* @since 3.1.0
1196	*
1197	* @param \Elementor\Widgets_Manager $widgets_manager Elementor widgets manager.
1198	*/
1199	public function register_elementor_widgets( \Elementor\Widgets_Manager $widgets_manager ): void {
1200	TablePress::load_file( 'class-elementor-widget-table.php', 'classes' );
1201	$widgets_manager->register( new TablePress\Elementor\TablePressTableWidget() ); // @phpstan-ignore method.notFound (Elementor methods are not in the stubs.)
1202	}
1203
1204	/**
1205	* Enqueues the TablePress Elementor Editor CSS styles.
1206	*
1207	* @since 3.1.0
1208	*/
1209	public function enqueue_elementor_editor_styles(): void {
1210	$svg_url = plugins_url( 'admin/img/tablepress-editor-button.svg', TABLEPRESS__FILE__ );
1211	wp_register_style( 'tablepress-elementor', false ); // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion
1212	wp_add_inline_style(
1213	'tablepress-elementor',
1214	<<<CSS
1215	.elementor-panel .elementor-element .icon:has(> .tablepress-elementor-icon) {
1216	height: 43.5px;
1217	}
1218	.tablepress-elementor-icon {
1219	display: inline-block;
1220	height: 28px;
1221	width: 28px;
1222	background-image: url({$svg_url});
1223	background-repeat: no-repeat;
1224	background-position: center;
1225	background-size: 28px auto;
1226	}
1227	CSS
1228	);
1229	wp_enqueue_style( 'tablepress-elementor' );
1230	}
1231
1232	} // class TablePress_Frontend_Controller
1233