PluginProbe
TablePress – Tables in WordPress made easy / 2.0.4
TablePress – Tables in WordPress made easy v2.0.4
3.3.4 3.3.3 3.3.2 3.3.1 trunk 1.12 1.14 1.9.2 2.0.4 2.1.7 2.1.8 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.3 2.3.1 2.3.2 2.4 2.4.1 2.4.2 2.4.3 2.4.4 All 44 releases
tablepress / controllers / controller-frontend.php

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

989 lines 39.1 KB
No matching file
Up and down to move Enter to open Esc to close
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 * List of tables that are shown for the current request.
26 *
27 * @since 1.0.0
28 * @var array
29 */
30 protected $shown_tables = array();
31
32 /**
33 * Initiate Frontend functionality.
34 *
35 * @since 1.0.0
36 */
37 public function __construct() {
38 parent::__construct();
39
40 /**
41 * Filters whether the TablePress Default CSS code shall be loaded.
42 *
43 * @since 1.0.0
44 *
45 * @param bool $use Whether the Default CSS shall be loaded. Default true.
46 */
47 if ( apply_filters( 'tablepress_use_default_css', true ) || TablePress::$model_options->get( 'use_custom_css' ) ) {
48 add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_css' ) );
49 }
50
51 // Add DataTables invocation calls.
52 add_action( 'wp_print_footer_scripts', array( $this, 'add_datatables_calls' ), 11 ); // After inclusion of files.
53
54 // Register TablePress Shortcodes. Priority 20 is kept for backwards-compatibility purposes.
55 add_action( 'init', array( $this, 'init_shortcodes' ), 20 );
56
57 /**
58 * Filters whether the WordPress search shall also search TablePress tables.
59 *
60 * @since 1.0.0
61 *
62 * @param bool $search Whether the TablePress tables shall be searched. Default true.
63 */
64 if ( apply_filters( 'tablepress_wp_search_integration', true ) ) {
65 // 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.
66 add_filter( 'posts_search', array( $this, 'posts_search_filter' ) );
67 }
68
69 /**
70 * Load TablePress Template Tag functions.
71 */
72 TablePress::load_file( 'template-tag-functions.php', 'controllers' );
73
74 /**
75 * Register the tablepress/table block and its dependencies.
76 */
77 register_block_type(
78 TABLEPRESS_ABSPATH . 'blocks/table/',
79 array(
80 'render_callback' => array( $this, 'table_block_render_callback' ),
81 )
82 );
83 }
84
85 /**
86 * Register TablePress Shortcodes.
87 *
88 * @since 1.0.0
89 */
90 public function init_shortcodes() {
91 add_shortcode( TablePress::$shortcode, array( $this, 'shortcode_table' ) );
92 add_shortcode( TablePress::$shortcode_info, array( $this, 'shortcode_table_info' ) );
93 }
94
95 /**
96 * Enqueue CSS files for default CSS and "Custom CSS" (if desired).
97 *
98 * @since 1.0.0
99 */
100 public function enqueue_css() {
101 /** This filter is documented in controllers/controller-frontend.php */
102 $use_default_css = apply_filters( 'tablepress_use_default_css', true );
103 $custom_css = TablePress::$model_options->get( 'custom_css' );
104 $use_custom_css = ( TablePress::$model_options->get( 'use_custom_css' ) && '' !== $custom_css );
105 $use_custom_css_file = ( $use_custom_css && TablePress::$model_options->get( 'use_custom_css_file' ) );
106 /**
107 * Filters the "Custom CSS" version number that is appended to the enqueued CSS files
108 *
109 * @since 1.0.0
110 *
111 * @param int $version The "Custom CSS" version.
112 */
113 $custom_css_version = apply_filters( 'tablepress_custom_css_version', TablePress::$model_options->get( 'custom_css_version' ) );
114
115 $tablepress_css = TablePress::load_class( 'TablePress_CSS', 'class-css.php', 'classes' );
116
117 // Determine Default CSS URL.
118 $rtl = ( is_rtl() ) ? '-rtl' : '';
119 $unfiltered_default_css_url = plugins_url( "css/build/default{$rtl}.css", TABLEPRESS__FILE__ );
120 /**
121 * Filters the URL from which the TablePress Default CSS file is loaded.
122 *
123 * @since 1.0.0
124 *
125 * @param string $unfiltered_default_css_url URL of the TablePress Default CSS file.
126 */
127 $default_css_url = apply_filters( 'tablepress_default_css_url', $unfiltered_default_css_url );
128
129 $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' ) );
130
131 if ( $use_custom_css_combined_file ) {
132 $custom_css_combined_url = $tablepress_css->get_custom_css_location( 'combined', 'url' );
133 // Need to use 'tablepress-default' instead of 'tablepress-combined' to not break existing TablePress Extensions.
134 wp_enqueue_style( 'tablepress-default', $custom_css_combined_url, array(), $custom_css_version );
135 } else {
136 $custom_css_dependencies = array();
137 if ( $use_default_css ) {
138 wp_enqueue_style( 'tablepress-default', $default_css_url, array(), TablePress::version );
139 // Add dependency to make sure that Custom CSS is printed after Default CSS.
140 $custom_css_dependencies[] = 'tablepress-default';
141 }
142
143 $use_custom_css_minified_file = ( $use_custom_css_file && ! SCRIPT_DEBUG && $tablepress_css->load_custom_css_from_file( 'minified' ) );
144 if ( $use_custom_css_minified_file ) {
145 $custom_css_minified_url = $tablepress_css->get_custom_css_location( 'minified', 'url' );
146 wp_enqueue_style( 'tablepress-custom', $custom_css_minified_url, $custom_css_dependencies, $custom_css_version );
147 return;
148 }
149
150 $use_custom_css_normal_file = ( $use_custom_css_file && $tablepress_css->load_custom_css_from_file( 'normal' ) );
151 if ( $use_custom_css_normal_file ) {
152 $custom_css_normal_url = $tablepress_css->get_custom_css_location( 'normal', 'url' );
153 wp_enqueue_style( 'tablepress-custom', $custom_css_normal_url, $custom_css_dependencies, $custom_css_version );
154 return;
155 }
156
157 if ( $use_custom_css ) {
158 // Get "Custom CSS" from options, try minified Custom CSS first.
159 $custom_css_minified = TablePress::$model_options->get( 'custom_css_minified' );
160 if ( ! empty( $custom_css_minified ) ) {
161 $custom_css = $custom_css_minified;
162 }
163 /**
164 * Filters the "Custom CSS" code that is to be loaded as inline CSS.
165 *
166 * @since 1.0.0
167 *
168 * @param string $custom_css The "Custom CSS" code.
169 */
170 $custom_css = apply_filters( 'tablepress_custom_css', $custom_css );
171 if ( ! empty( $custom_css ) ) {
172 // wp_add_inline_style() requires a loaded CSS file, so we have to work around that if "Default CSS" is disabled.
173 if ( $use_default_css ) {
174 // Handle of the file to which the <style> shall be appended.
175 wp_add_inline_style( 'tablepress-default', $custom_css );
176 } else {
177 add_action( 'wp_head', array( $this, '_print_custom_css' ), 8 ); // Priority 8 to hook in right after WP_Styles has been processed.
178 }
179 }
180 }
181 }
182 }
183
184 /**
185 * Print "Custom CSS" to "wp_head" inline.
186 *
187 * This is necessary if "Default CSS" is off, and saving "Custom CSS" to a file is not possible.
188 *
189 * @since 1.0.0
190 */
191 public function _print_custom_css() {
192 // Get "Custom CSS" from options, try minified Custom CSS first.
193 $custom_css = TablePress::$model_options->get( 'custom_css_minified' );
194 if ( empty( $custom_css ) ) {
195 $custom_css = TablePress::$model_options->get( 'custom_css' );
196 }
197 /** This filter is documented in controllers/controller-frontend.php */
198 $custom_css = apply_filters( 'tablepress_custom_css', $custom_css );
199 echo "<style>\n{$custom_css}\n</style>\n";
200 }
201
202 /**
203 * Enqueue the DataTables JavaScript library and its dependencies.
204 *
205 * @since 1.0.0
206 */
207 protected function _enqueue_datatables() {
208 $js_file = 'js/jquery.datatables.min.js';
209 $js_url = plugins_url( $js_file, TABLEPRESS__FILE__ );
210 /**
211 * Filters the URL from which the DataTables JavaScript library file is loaded.
212 *
213 * @since 1.0.0
214 *
215 * @param string $js_url URL of the DataTables JS library file.
216 * @param string $js_file Path and file name of the DataTables JS library file.
217 */
218 $js_url = apply_filters( 'tablepress_datatables_js_url', $js_url, $js_file );
219 wp_enqueue_script( 'tablepress-datatables', $js_url, array( 'jquery-core' ), TablePress::version, true );
220 }
221
222 /**
223 * Add JS code for invocation of DataTables JS library.
224 *
225 * @since 1.0.0
226 */
227 public function add_datatables_calls() {
228 // Prevent repeated execution (which would lead to DataTables error messages) via a static variable.
229 static $datatables_calls_printed = false;
230 if ( $datatables_calls_printed ) {
231 return;
232 }
233
234 if ( empty( $this->shown_tables ) ) {
235 // There are no tables with activated DataTables on the page that is currently rendered.
236 return;
237 }
238
239 // Storage for the DataTables language strings.
240 $datatables_language = array();
241 // Generate the specific JS commands, depending on chosen features on the "Edit" screen and the Shortcode parameters.
242 $commands = array();
243
244 foreach ( $this->shown_tables as $table_id => $table_store ) {
245 if ( empty( $table_store['instances'] ) ) {
246 continue;
247 }
248
249 foreach ( $table_store['instances'] as $html_id => $js_options ) {
250 $parameters = array();
251
252 // Settle dependencies/conflicts between certain features.
253 if ( false !== $js_options['datatables_scrolly'] ) { // datatables_scrolly can be a string, so that the explicit `false` check is needed.
254 // Vertical scrolling and pagination don't work together.
255 $js_options['datatables_paginate'] = false;
256 }
257 // Sanitize, as it may come from a Shortcode attribute.
258 $js_options['datatables_paginate_entries'] = (int) $js_options['datatables_paginate_entries'];
259
260 /*
261 * DataTables language/translation handling.
262 */
263
264 /**
265 * Filters the locale/language for the DataTables JavaScript library.
266 *
267 * @since 1.0.0
268 *
269 * @param string $locale The DataTables JS library locale.
270 * @param string $table_id The current table ID.
271 */
272 $datatables_locale = apply_filters( 'tablepress_datatables_locale', $js_options['datatables_locale'], $table_id );
273
274 // Only load each locale's language file once.
275 if ( ! isset( $datatables_language[ $datatables_locale ] ) ) {
276 $orig_language_file = TABLEPRESS_ABSPATH . "i18n/datatables/lang-{$datatables_locale}.php";
277
278 /**
279 * Filters the language file path for the DataTables JavaScript library.
280 *
281 * PHP files that return an array and JSON files are supported.
282 * The JSON file method is deprecated and should no longer be used.
283 *
284 * @since 1.0.0
285 *
286 * @param string $orig_language_file Language file path for the DataTables JS library.
287 * @param string $datatables_locale Current locale/language for the DataTables JS library.
288 * @param string $tablepress_abspath Base path of the TablePress plugin.
289 */
290 $language_file = apply_filters( 'tablepress_datatables_language_file', $orig_language_file, $datatables_locale, TABLEPRESS_ABSPATH );
291
292 /*
293 * Load translation file if it's not "en_US" (included as the default in DataTables)
294 * or if the filter was used to change the language file, and the language file exists.
295 * Otherwise, use an empty en_US placeholder, so that the strings are filterable later.
296 */
297 if ( ( 'en_US' !== $datatables_locale || $orig_language_file !== $language_file ) && file_exists( $language_file ) ) {
298 if ( 0 === substr_compare( $language_file, '.php', -4, 4, false ) ) {
299 $datatables_strings = require $language_file;
300 if ( ! is_array( $datatables_strings ) ) {
301 $datatables_strings = array();
302 }
303 } elseif ( 0 === substr_compare( $language_file, '.json', -5, 5, false ) ) {
304 $datatables_strings = file_get_contents( $language_file );
305 $datatables_strings = json_decode( $datatables_strings, true );
306 // Check if JSON could be decoded.
307 if ( is_null( $datatables_strings ) ) {
308 $datatables_strings = array();
309 }
310 $datatables_strings = (array) $datatables_strings;
311 } else {
312 // The filtered language file exists, but is not a .php or .json file, so don't use it.
313 $datatables_strings = array();
314 }
315 } else {
316 // If no translation file for the defined locale exists or is needed, use "en_US", as that's built-in.
317 $datatables_locale = 'en_US';
318 $datatables_strings = array();
319 }
320
321 /**
322 * Filters the language strings for the DataTables JavaScript library's features.
323 *
324 * @since 2.0.0
325 *
326 * @param array $datatables_strings The language strings for DataTables.
327 * @param string $datatables_locale Current locale/language for the DataTables JS library.
328 */
329 $datatables_language[ $datatables_locale ] = apply_filters( 'tablepress_datatables_language_strings', $datatables_strings, $datatables_locale );
330 }
331 $parameters['language'] = '"language":DT_language["' . $datatables_locale . '"]';
332
333 // These parameters need to be added for performance gain or to overwrite unwanted default behavior.
334 if ( $js_options['datatables_sort'] ) {
335 // No initial sort.
336 $parameters['order'] = '"order":[]';
337 // Don't add additional classes, to speed up sorting.
338 $parameters['orderClasses'] = '"orderClasses":false';
339 }
340
341 // Alternating row colors is default, so remove them if not wanted with [].
342 $parameters['stripeClasses'] = '"stripeClasses":' . ( ( $js_options['alternating_row_colors'] ) ? '["even","odd"]' : '[]' );
343
344 // 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.
345 if ( ! $js_options['datatables_sort'] ) {
346 $parameters['ordering'] = '"ordering":false';
347 }
348 if ( $js_options['datatables_paginate'] ) {
349 $parameters['pagingType'] = '"pagingType":"simple"';
350 if ( $js_options['datatables_lengthchange'] ) {
351 $length_menu = array( 10, 25, 50, 100 );
352 if ( ! in_array( $js_options['datatables_paginate_entries'], $length_menu, true ) ) {
353 $length_menu[] = $js_options['datatables_paginate_entries'];
354 sort( $length_menu, SORT_NUMERIC );
355 $parameters['lengthMenu'] = '"lengthMenu":[' . implode( ',', $length_menu ) . ']';
356 }
357 } else {
358 $parameters['lengthChange'] = '"lengthChange":false';
359 }
360 if ( 10 !== $js_options['datatables_paginate_entries'] ) {
361 $parameters['pageLength'] = '"pageLength":' . $js_options['datatables_paginate_entries'];
362 }
363 } else {
364 $parameters['paging'] = '"paging":false';
365 }
366 if ( ! $js_options['datatables_filter'] ) {
367 $parameters['searching'] = '"searching":false';
368 }
369 if ( ! $js_options['datatables_info'] ) {
370 $parameters['info'] = '"info":false';
371 }
372 if ( $js_options['datatables_scrollx'] ) {
373 $parameters['scrollX'] = '"scrollX":true';
374 }
375 if ( false !== $js_options['datatables_scrolly'] ) {
376 $parameters['scrollY'] = '"scrollY":"' . preg_replace( '#[^0-9a-z.%]#', '', $js_options['datatables_scrolly'] ) . '"';
377 $parameters['scrollCollapse'] = '"scrollCollapse":true';
378 }
379 if ( ! empty( $js_options['datatables_custom_commands'] ) ) {
380 $parameters['custom_commands'] = $js_options['datatables_custom_commands'];
381 }
382
383 /**
384 * Filters the parameters that are passed to the DataTables JavaScript library.
385 *
386 * @since 1.0.0
387 *
388 * @param array $parameters The parameters for the DataTables JS library.
389 * @param string $table_id The current table ID.
390 * @param string $html_id The ID of the table HTML element.
391 * @param array $js_options The options for the JS library.
392 */
393 $parameters = apply_filters( 'tablepress_datatables_parameters', $parameters, $table_id, $html_id, $js_options );
394
395 // If an existing parameter (in the from `"parameter":`) is set in the "Custom Commands", remove its default value.
396 if ( isset( $parameters['custom_commands'] ) ) {
397 foreach ( array_keys( $parameters ) as $maybe_overwritten_parameter ) {
398 if ( false !== strpos( $parameters['custom_commands'], "\"{$maybe_overwritten_parameter}\":" ) ) {
399 unset( $parameters[ $maybe_overwritten_parameter ] );
400 }
401 }
402 }
403
404 $parameters = implode( ',', $parameters );
405 $parameters = ( ! empty( $parameters ) ) ? '{' . $parameters . '}' : '';
406
407 $command = "$('#{$html_id}').DataTable({$parameters});";
408 /**
409 * Filters the JavaScript command that invokes the DataTables JavaScript library on one table.
410 *
411 * @since 1.0.0
412 *
413 * @param string $command The JS command for the DataTables JS library.
414 * @param string $html_id The ID of the table HTML element.
415 * @param string $parameters The parameters for the DataTables JS library.
416 * @param string $table_id The current table ID.
417 * @param array $js_options The options for the JS library.
418 */
419 $command = apply_filters( 'tablepress_datatables_command', $command, $html_id, $parameters, $table_id, $js_options );
420 if ( ! empty( $command ) ) {
421 $commands[] = $command;
422 }
423 } // foreach table instance
424 } // foreach table ID
425
426 // DataTables language/translation handling.
427 if ( ! empty( $datatables_language ) ) {
428 $datatables_language = wp_json_encode( $datatables_language, JSON_UNESCAPED_UNICODE | JSON_FORCE_OBJECT );
429 $datatables_language = "var DT_language={$datatables_language};\n";
430 }
431
432 $commands = implode( "\n", $commands );
433 /**
434 * Filters the JavaScript commands that invoke the DataTables JavaScript library on all tables on the page.
435 *
436 * @since 1.0.0
437 *
438 * @param string $commands The JS commands for the DataTables JS library.
439 */
440 $commands = apply_filters( 'tablepress_all_datatables_commands', $commands );
441 if ( empty( $commands ) ) {
442 return;
443 }
444
445 $script_type_attr = current_theme_supports( 'html5', 'script' ) ? '' : ' type="text/javascript"';
446
447 $js_wrapper = <<<'JS'
448 <script%3$s>
449 jQuery(function($){
450 %1$s%2$s
451 });
452 </script>
453 JS;
454 /**
455 * Filters the script/jQuery wrapper code for the DataTables commands calls.
456 *
457 * @since 1.14.0
458 *
459 * @param string $js_wrapper Default script/jQuery wrapper code for the DataTables commands calls.
460 */
461 $js_wrapper = apply_filters( 'tablepress_all_datatables_commands_wrapper', $js_wrapper );
462 printf( $js_wrapper, $datatables_language, $commands, $script_type_attr );
463
464 // Prevent repeated execution (which would lead to DataTables error messages) via a static variable.
465 $datatables_calls_printed = true;
466 }
467
468 /**
469 * Handle Shortcode [table id=<ID> /].
470 *
471 * @since 1.0.0
472 *
473 * @param array $shortcode_atts List of attributes that where included in the Shortcode.
474 * @return string Resulting HTML code for the table with the ID <ID>.
475 */
476 public function shortcode_table( $shortcode_atts ) {
477 // Don't use `array` type hint in method declaration, as for empty Shortcodes like [table] or [table /], an empty string is passed, see WP Core #26927.
478 $shortcode_atts = (array) $shortcode_atts;
479
480 $_render = TablePress::load_class( 'TablePress_Render', 'class-render.php', 'classes' );
481
482 $default_shortcode_atts = $_render->get_default_render_options();
483 /**
484 * Filters the available/default attributes for the [table] Shortcode.
485 *
486 * @since 1.0.0
487 *
488 * @param array $default_shortcode_atts The [table] Shortcode default attributes.
489 */
490 $default_shortcode_atts = apply_filters( 'tablepress_shortcode_table_default_shortcode_atts', $default_shortcode_atts );
491 // Parse Shortcode attributes, only allow those that are specified.
492 $shortcode_atts = shortcode_atts( $default_shortcode_atts, $shortcode_atts ); // Optional third argument left out on purpose. Use filter in the next line instead.
493 /**
494 * Filters the attributes that were passed to the [table] Shortcode.
495 *
496 * @since 1.0.0
497 *
498 * @param array $shortcode_atts The attributes passed to the [table] Shortcode.
499 */
500 $shortcode_atts = apply_filters( 'tablepress_shortcode_table_shortcode_atts', $shortcode_atts );
501
502 // Check, if a table with the given ID exists.
503 $table_id = preg_replace( '/[^a-zA-Z0-9_-]/', '', $shortcode_atts['id'] );
504 if ( ! TablePress::$model_table->table_exists( $table_id ) ) {
505 $message = "[table &#8220;{$table_id}&#8221; not found /]<br />\n";
506 /**
507 * Filters the "Table not found" message.
508 *
509 * @since 1.0.0
510 *
511 * @param string $message The "Table not found" message.
512 * @param string $table_id The current table ID.
513 */
514 $message = apply_filters( 'tablepress_table_not_found_message', $message, $table_id );
515 return $message;
516 }
517
518 // Load table, with table data, options, and visibility settings.
519 $table = TablePress::$model_table->load( $table_id, true, true );
520 if ( is_wp_error( $table ) ) {
521 $message = "[table &#8220;{$table_id}&#8221; could not be loaded /]<br />\n";
522 /**
523 * Filters the "Table could not be loaded" message.
524 *
525 * @since 1.0.0
526 *
527 * @param string $message The "Table could not be loaded" message.
528 * @param string $table_id The current table ID.
529 * @param WP_Error $table The error object for the table.
530 */
531 $message = apply_filters( 'tablepress_table_load_error_message', $message, $table_id, $table );
532 return $message;
533 }
534 if ( isset( $table['is_corrupted'] ) && $table['is_corrupted'] ) {
535 $message = "<div>Attention: The internal data of table &#8220;{$table_id}&#8221; is corrupted!</div>";
536 /**
537 * Filters the "Table data is corrupted" message.
538 *
539 * @since 1.0.0
540 *
541 * @param string $message The "Table data is corrupted" message.
542 * @param string $table_id The current table ID.
543 * @param string $json_error The JSON error with information about the corrupted table.
544 */
545 $message = apply_filters( 'tablepress_table_corrupted_message', $message, $table_id, $table['json_error'] );
546 return $message;
547 }
548
549 /**
550 * Filters whether the "datatables_custom_commands" Shortcode parameter is disabled.
551 *
552 * By default, the "datatables_custom_commands" Shortcode parameter is disabled for security reasons.
553 *
554 * @since 1.0.0
555 *
556 * @param bool $disable Whether to disable the "datatables_custom_commands" Shortcode parameter. Default true.
557 */
558 if ( ! is_null( $shortcode_atts['datatables_custom_commands'] ) && apply_filters( 'tablepress_disable_custom_commands_shortcode_parameter', true ) ) {
559 $shortcode_atts['datatables_custom_commands'] = null;
560 }
561
562 // Determine options to use (if set in Shortcode, use those, otherwise use stored options, from the "Edit" screen).
563 $render_options = array();
564 foreach ( $shortcode_atts as $key => $value ) {
565 // We have to check this, because strings 'true' or 'false' are not recognized as boolean!
566 if ( is_string( $value ) && 'true' === strtolower( $value ) ) {
567 $render_options[ $key ] = true;
568 } elseif ( is_string( $value ) && 'false' === strtolower( $value ) ) {
569 $render_options[ $key ] = false;
570 } elseif ( is_null( $value ) && isset( $table['options'][ $key ] ) ) {
571 $render_options[ $key ] = $table['options'][ $key ];
572 } else {
573 $render_options[ $key ] = $value;
574 }
575 }
576
577 // Generate unique HTML ID, depending on how often this table has already been shown on this page.
578 if ( ! isset( $this->shown_tables[ $table_id ] ) ) {
579 $this->shown_tables[ $table_id ] = array(
580 'count' => 0,
581 'instances' => array(),
582 );
583 }
584 ++$this->shown_tables[ $table_id ]['count'];
585 $count = $this->shown_tables[ $table_id ]['count'];
586 $render_options['html_id'] = "tablepress-{$table_id}";
587 if ( $count > 1 ) {
588 $render_options['html_id'] .= "-no-{$count}";
589 }
590 /**
591 * Filters the ID of the table HTML element.
592 *
593 * @since 1.0.0
594 *
595 * @param string $html_id The ID of the table HTML element.
596 * @param string $table_id The current table ID.
597 * @param string $count Number of copies of the table with this table ID on the page.
598 */
599 $render_options['html_id'] = apply_filters( 'tablepress_html_id', $render_options['html_id'], $table_id, $count );
600
601 // Generate the "Edit Table" link.
602 $render_options['edit_table_url'] = '';
603 /**
604 * Filters whether the "Edit" link below the table shall be shown.
605 *
606 * The "Edit" link is only shown to logged-in users who possess the necessary capability to edit the table.
607 *
608 * @since 1.0.0
609 *
610 * @param bool $show Whether to show the "Edit" link below the table. Default true.
611 * @param string $table_id The current table ID.
612 */
613 if ( is_user_logged_in() && apply_filters( 'tablepress_edit_link_below_table', true, $table['id'] ) && current_user_can( 'tablepress_edit_table', $table['id'] ) ) {
614 $render_options['edit_table_url'] = TablePress::url( array( 'action' => 'edit', 'table_id' => $table['id'] ) );
615 }
616
617 /**
618 * Filters the render options for the table.
619 *
620 * The render options are determined from the settings on a table's "Edit" screen and the Shortcode parameters.
621 *
622 * @since 1.0.0
623 *
624 * @param array $render_options The render options for the table.
625 * @param array $table The current table.
626 */
627 $render_options = apply_filters( 'tablepress_table_render_options', $render_options, $table );
628
629 // Check if table output shall and can be loaded from the transient cache, otherwise generate the output.
630 if ( $render_options['cache_table_output'] && ! is_user_logged_in() ) {
631 // Hash the Render Options array to get a unique cache identifier.
632 $table_hash = md5( wp_json_encode( $render_options, TABLEPRESS_JSON_OPTIONS ) );
633 $transient_name = 'tablepress_' . $table_hash; // Attention: This string must not be longer than 45 characters!
634 $output = get_transient( $transient_name );
635 if ( false === $output || '' === $output ) {
636 // Render/generate the table HTML, as it was not found in the cache.
637 $_render->set_input( $table, $render_options );
638 $output = $_render->get_output();
639 // Save render output in a transient, set cache timeout to 24 hours.
640 set_transient( $transient_name, $output, DAY_IN_SECONDS );
641 // Update output caches list transient (necessary for cache invalidation upon table saving).
642 $caches_list_transient_name = 'tablepress_c_' . md5( $table_id );
643 $caches_list = get_transient( $caches_list_transient_name );
644 if ( false === $caches_list ) {
645 $caches_list = array();
646 } else {
647 $caches_list = (array) json_decode( $caches_list, true );
648 }
649 if ( ! in_array( $transient_name, $caches_list, true ) ) {
650 $caches_list[] = $transient_name;
651 }
652 set_transient( $caches_list_transient_name, wp_json_encode( $caches_list, TABLEPRESS_JSON_OPTIONS ), 2 * DAY_IN_SECONDS );
653 } else {
654 /**
655 * Filters the cache hit comment message.
656 *
657 * @since 1.0.0
658 *
659 * @param string $comment The cache hit comment message.
660 */
661 $output .= apply_filters( 'tablepress_cache_hit_comment', "<!-- #{$render_options['html_id']} from cache -->" );
662 }
663 } else {
664 // Render/generate the table HTML, as no cache is to be used.
665 $_render->set_input( $table, $render_options );
666 $output = $_render->get_output();
667 }
668
669 // 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.
670 if ( $render_options['use_datatables']
671 && $render_options['table_head']
672 && false !== strpos( $output, '<thead' ) // A `<thead>` tag is required.
673 && false === strpos( $output, ' colspan="' ) // `colspan` attributes are forbidden.
674 && false === strpos( $output, ' rowspan="' ) // `rowspan` attributes are forbidden.
675 ) {
676 // Get options for the DataTables JavaScript library from the table's render options.
677 $js_options = array();
678 foreach ( array(
679 'alternating_row_colors',
680 'datatables_sort',
681 'datatables_paginate',
682 'datatables_paginate',
683 'datatables_paginate_entries',
684 'datatables_lengthchange',
685 'datatables_filter',
686 'datatables_info',
687 'datatables_scrollx',
688 'datatables_scrolly',
689 'datatables_locale',
690 'datatables_custom_commands',
691 ) as $option ) {
692 $js_options[ $option ] = $render_options[ $option ];
693 }
694 /**
695 * Filters the JavaScript options for the table.
696 *
697 * The JavaScript options are determined from the settings on a table's "Edit" screen and the Shortcode parameters.
698 * They are part of the render options and can be overwritten with Shortcode parameters.
699 *
700 * @since 1.0.0
701 *
702 * @param array $js_options The JavaScript options for the table.
703 * @param string $table_id The current table ID.
704 * @param array $render_options The render options for the table.
705 */
706 $js_options = apply_filters( 'tablepress_table_js_options', $js_options, $table_id, $render_options );
707 $this->shown_tables[ $table_id ]['instances'][ $render_options['html_id'] ] = $js_options;
708 $this->_enqueue_datatables();
709 }
710
711 // Maybe print a list of used render options.
712 if ( $render_options['shortcode_debug'] && is_user_logged_in() ) {
713 $output .= '<pre>' . var_export( $render_options, true ) . '</pre>';
714 }
715
716 return $output;
717 }
718
719 /**
720 * Handle Shortcode [table-info id=<ID> field=<name> /].
721 *
722 * @since 1.0.0
723 *
724 * @param array $shortcode_atts List of attributes that where included in the Shortcode.
725 * @return string Text that replaces the Shortcode (error message or asked-for information).
726 */
727 public function shortcode_table_info( $shortcode_atts ) {
728 // Don't use `array` type hint in method declaration, as for empty Shortcodes like [table-info] or [table-info /], an empty string is passed, see WP Core #26927.
729 $shortcode_atts = (array) $shortcode_atts;
730
731 // Parse Shortcode attributes, only allow those that are specified.
732 $default_shortcode_atts = array(
733 'id' => '',
734 'field' => '',
735 'format' => '',
736 );
737 /**
738 * Filters the available/default attributes for the [table-info] Shortcode.
739 *
740 * @since 1.0.0
741 *
742 * @param array $default_shortcode_atts The [table-info] Shortcode default attributes.
743 */
744 $default_shortcode_atts = apply_filters( 'tablepress_shortcode_table_info_default_shortcode_atts', $default_shortcode_atts );
745 $shortcode_atts = shortcode_atts( $default_shortcode_atts, $shortcode_atts ); // Optional third argument left out on purpose. Use filter in the next line instead.
746 /**
747 * Filters the attributes that were passed to the [table-info] Shortcode.
748 *
749 * @since 1.0.0
750 *
751 * @param array $shortcode_atts The attributes passed to the [table-info] Shortcode.
752 */
753 $shortcode_atts = apply_filters( 'tablepress_shortcode_table_info_shortcode_atts', $shortcode_atts );
754
755 /**
756 * Filters whether the output of the [table-info] Shortcode is overwritten/short-circuited.
757 *
758 * @since 1.0.0
759 *
760 * @param bool|string $overwrite Whether the [table-info] output is overwritten. Return false for the regular content, and a string to overwrite the output.
761 * @param array $shortcode_atts The attributes passed to the [table-info] Shortcode.
762 */
763 $overwrite = apply_filters( 'tablepress_shortcode_table_info_overwrite', false, $shortcode_atts );
764 if ( $overwrite ) {
765 return $overwrite;
766 }
767
768 // Check, if a table with the given ID exists.
769 $table_id = preg_replace( '/[^a-zA-Z0-9_-]/', '', $shortcode_atts['id'] );
770 if ( ! TablePress::$model_table->table_exists( $table_id ) ) {
771 $message = "[table &#8220;{$table_id}&#8221; not found /]<br />\n";
772 /** This filter is documented in controllers/controller-frontend.php */
773 $message = apply_filters( 'tablepress_table_not_found_message', $message, $table_id );
774 return $message;
775 }
776
777 // Load table, with table data, options, and visibility settings.
778 $table = TablePress::$model_table->load( $table_id, true, true );
779 if ( is_wp_error( $table ) ) {
780 $message = "[table &#8220;{$table_id}&#8221; could not be loaded /]<br />\n";
781 /** This filter is documented in controllers/controller-frontend.php */
782 $message = apply_filters( 'tablepress_table_load_error_message', $message, $table_id, $table );
783 return $message;
784 }
785
786 $field = preg_replace( '/[^a-z_]/', '', strtolower( $shortcode_atts['field'] ) );
787 $format = preg_replace( '/[^a-z]/', '', strtolower( $shortcode_atts['format'] ) );
788
789 // Generate output, depending on what information (field) was asked for.
790 switch ( $field ) {
791 case 'name':
792 case 'description':
793 $output = $table[ $field ];
794 break;
795 case 'last_modified':
796 switch ( $format ) {
797 case 'raw':
798 case 'mysql':
799 $output = $table['last_modified'];
800 break;
801 case 'human':
802 $modified_timestamp = date_create( $table['last_modified'], wp_timezone() );
803 $modified_timestamp = $modified_timestamp->getTimestamp();
804 $current_timestamp = time();
805 $time_diff = $current_timestamp - $modified_timestamp;
806 // Time difference is only shown up to one week.
807 if ( $time_diff >= 0 && $time_diff < WEEK_IN_SECONDS ) {
808 $output = sprintf( __( '%s ago', 'default' ), human_time_diff( $modified_timestamp, $current_timestamp ) );
809 } else {
810 $output = TablePress::format_datetime( $table['last_modified'], '<br />' );
811 }
812 break;
813 case 'date':
814 $output = TablePress::format_datetime( $table['last_modified'], get_option( 'date_format' ) );
815 break;
816 case 'time':
817 $output = TablePress::format_datetime( $table['last_modified'], get_option( 'time_format' ) );
818 break;
819 default:
820 $output = TablePress::format_datetime( $table['last_modified'] );
821 break;
822 }
823 break;
824 case 'last_editor':
825 $output = TablePress::get_user_display_name( $table['options']['last_editor'] );
826 break;
827 case 'author':
828 $output = TablePress::get_user_display_name( $table['author'] );
829 break;
830 case 'number_rows':
831 $output = count( $table['data'] );
832 if ( 'raw' !== $format ) {
833 if ( $table['options']['table_head'] ) {
834 $output = $output - 1;
835 }
836 if ( $table['options']['table_foot'] ) {
837 $output = $output - 1;
838 }
839 }
840 break;
841 case 'number_columns':
842 $output = count( $table['data'][0] );
843 break;
844 default:
845 $output = "[table-info field &#8220;{$field}&#8221; not found in table &#8220;{$table_id}&#8221; /]<br />\n";
846 /**
847 * Filters the "table info field not found" message.
848 *
849 * @since 1.0.0
850 *
851 * @param string $output The "table info field not found" message.
852 * @param array $table The current table ID.
853 * @param string $field The field that was not found.
854 * @param string $format The return format for the field.
855 */
856 $output = apply_filters( 'tablepress_table_info_not_found_message', $output, $table, $field, $format );
857 }
858
859 /**
860 * Filters the output of the [table-info] Shortcode.
861 *
862 * @since 1.0.0
863 *
864 * @param string $output The output of the [table-info] Shortcode.
865 * @param array $table The current table.
866 * @param array $shortcode_atts The attributes passed to the [table-info] Shortcode.
867 */
868 $output = apply_filters( 'tablepress_shortcode_table_info_output', $output, $table, $shortcode_atts );
869 return $output;
870 }
871
872 /**
873 * Expand WP Search to also find posts and pages that have a search term in a table that is shown in them.
874 *
875 * This is done by looping through all search terms and TablePress tables and searching there for the search term,
876 * 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
877 * Shortcode for one of these tables in their content.
878 *
879 * @since 1.0.0
880 *
881 * @global wpdb $wpdb WordPress database abstraction object.
882 *
883 * @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.
884 * @return string Eventually extended SQL "WHERE" clause, to also find posts/pages with Shortcodes in them.
885 */
886 public function posts_search_filter( $search_sql ) {
887 global $wpdb;
888
889 if ( ! is_search() || ! is_main_query() ) {
890 return $search_sql;
891 }
892
893 // Get variable that contains all search terms, parsed from $_GET['s'] by WP.
894 $search_terms = get_query_var( 'search_terms' );
895 if ( empty( $search_terms ) || ! is_array( $search_terms ) ) {
896 return $search_sql;
897 }
898
899 // 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.
900 $table_ids = TablePress::$model_table->load_all( true, false );
901 // Array of all search words that were found, and the table IDs where they were found.
902 $query_result = array();
903
904 foreach ( $table_ids as $table_id ) {
905 // Load table, with table data, options, and visibility settings.
906 $table = TablePress::$model_table->load( $table_id, true, true );
907
908 if ( isset( $table['is_corrupted'] ) && $table['is_corrupted'] ) {
909 // Do not search in corrupted tables.
910 continue;
911 }
912
913 foreach ( $search_terms as $search_term ) {
914 if ( ( $table['options']['print_name'] && false !== stripos( $table['name'], $search_term ) )
915 || ( $table['options']['print_description'] && false !== stripos( $table['description'], $search_term ) ) ) {
916 // Found the search term in the name or description (and they are shown).
917 $query_result[ $search_term ][] = $table_id; // Add table ID to result list.
918 // No need to continue searching this search term in this table.
919 continue;
920 }
921
922 // Search search term in visible table cells (without taking Shortcode parameters into account!).
923 foreach ( $table['data'] as $row_idx => $table_row ) {
924 if ( 0 === $table['visibility']['rows'][ $row_idx ] ) {
925 // Row is hidden, so don't search in it.
926 continue;
927 }
928 foreach ( $table_row as $col_idx => $table_cell ) {
929 if ( 0 === $table['visibility']['columns'][ $col_idx ] ) {
930 // Column is hidden, so don't search in it.
931 continue;
932 }
933 // @TODO: Cells are not evaluated here, so math formulas are searched.
934 if ( false !== stripos( $table_cell, $search_term ) ) {
935 // Found the search term in the cell content.
936 $query_result[ $search_term ][] = $table_id; // Add table ID to result list
937 // No need to continue searching this search term in this table.
938 continue 3;
939 }
940 }
941 }
942 }
943 }
944
945 // For all found table IDs for each search term, add additional OR statement to the SQL "WHERE" clause.
946
947 // If $_GET['exact'] is set, WordPress doesn't use % in SQL LIKE clauses.
948 $exact = get_query_var( 'exact' );
949 $n = ( empty( $exact ) ) ? '%' : '';
950 $search_sql = $wpdb->remove_placeholder_escape( $search_sql );
951 foreach ( $query_result as $search_term => $table_ids ) {
952 $search_term = esc_sql( $wpdb->esc_like( $search_term ) );
953 $old_or = "OR ({$wpdb->posts}.post_content LIKE '{$n}{$search_term}{$n}')";
954 $table_ids = implode( '|', $table_ids );
955 $regexp = '\\\\[' . TablePress::$shortcode . ' id=(["\\\']?)(' . $table_ids . ')([\]"\\\' /])'; // ' needs to be single escaped, [ double escaped (with \\) in mySQL
956 $new_or = $old_or . " OR ({$wpdb->posts}.post_content REGEXP '{$regexp}')";
957 $search_sql = str_replace( $old_or, $new_or, $search_sql );
958 }
959 $search_sql = $wpdb->add_placeholder_escape( $search_sql );
960
961 return $search_sql;
962 }
963
964 /**
965 * Callback function for rendering the tablepress/table block.
966 *
967 * @since 2.0.0
968 *
969 * @param array $block_attributes List of attributes that where included in the block settings.
970 * @return string Resulting HTML code for the table.
971 */
972 public function table_block_render_callback( array $block_attributes ) {
973 // Don't return anything if no table was selected.
974 if ( '' === $block_attributes['id'] ) {
975 return;
976 }
977
978 if ( '' !== trim( $block_attributes['parameters'] ) ) {
979 $render_attributes = shortcode_parse_atts( $block_attributes['parameters'] );
980 } else {
981 $render_attributes = array();
982 }
983 $render_attributes['id'] = $block_attributes['id'];
984
985 return $this->shortcode_table( $render_attributes );
986 }
987
988 } // class TablePress_Frontend_Controller
989