-
Notifications
You must be signed in to change notification settings - Fork 89
/
Copy pathUtil_Ui.php
2538 lines (2325 loc) · 83 KB
/
Util_Ui.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* File: Util_Ui.php
*
* @package W3TC
*/
namespace W3TC;
use DOMDocument;
/**
* Class Util_Ui
*
* phpcs:disable WordPress.PHP.NoSilencedErrors.Discouraged
*/
class Util_Ui {
/**
* Returns button html
*
* @param string $text Text.
* @param string $onclick On click.
* @param string $class_value Class.
* @param string $name Name.
*
* @return string
*/
public static function button( $text, $onclick = '', $class_value = 'button', $name = '' ) {
$maybe_name = ( empty( $name ) ? '' : ' name="' . esc_attr( $name ) . '"' );
return '<input type="button"' . $maybe_name . ' class="' . esc_attr( $class_value ) . '" value="' .
esc_attr( $text ) . '" onclick="' . esc_attr( $onclick ) . '" />';
}
/**
* Returns button link html.
*
* @param string $text Text.
* @param string $url URL.
* @param bool $new_window Open link in a new window.
* @param string $class_value Class.
* @param string $name Name.
*
* @return string
*/
public static function button_link( $text, $url, $new_window = false, $class_value = 'button', $name = '' ) {
$url = str_replace( '&', '&', $url );
if ( $new_window ) {
$onclick = sprintf( 'window.open(\'%s\');', addslashes( $url ) );
} else {
$onclick = '';
if ( strpos( $class_value, 'w3tc-button-ignore-change' ) >= 0 ) {
$onclick .= 'w3tc_beforeupload_unbind(); ';
}
$onclick .= sprintf( 'document.location.href=\'%s\';', addslashes( $url ) );
}
return self::button( $text, $onclick, $class_value, $name );
}
/**
* Generates a URL with a nonce.
*
* @param array $addon {
* Addon parameters used to build the URL.
*
* @type string $page Optional. The page parameter. Defaults to 'w3tc_dashboard'.
* }
*
* @return string The generated URL with a nonce.
*/
public static function url( $addon ) {
if ( ! isset( $addon['page'] ) ) {
$addon['page'] = Util_Request::get_string( 'page', 'w3tc_dashboard' );
}
$url = 'admin.php';
$amp = '?';
foreach ( $addon as $key => $value ) {
$url .= $amp . rawurlencode( $key ) . '=' . rawurlencode( $value );
$amp = '&';
}
$url = wp_nonce_url( $url, 'w3tc' );
return $url;
}
/**
* Returns hide note button html
*
* @param string $text Text.
* @param string $note Note.
* @param string $redirect Redirect.
* @param boolean $admin If to use config admin.
* @param string $page Page.
* @param string $custom_method Custom method.
*
* @return string
*/
public static function button_hide_note(
$text,
$note,
$redirect = '',
$admin = false,
$page = '',
$custom_method = 'w3tc_default_hide_note'
) {
if ( '' === $page ) {
$page = Util_Request::get_string( 'page', 'w3tc_dashboard' );
}
$url = sprintf( 'admin.php?page=%s&%s¬e=%s', $page, $custom_method, $note );
if ( $admin ) {
$url .= '&admin=1';
}
if ( '' !== $redirect ) {
$url .= '&redirect=' . rawurlencode( $redirect );
}
$url = wp_nonce_url( $url, 'w3tc' );
return self::button_link( $text, $url, false, 'button', 'w3tc_hide_' . $custom_method );
}
/**
* Hide note button.
*
* @param array $parameters {
* Parameters for generating the hide note button.
*
* @type string $key The configuration key used to generate the button ID.
* }
*
* @return string The generated button HTML.
*/
public static function button_hide_note2( $parameters ) {
return self::button_link(
__( 'Hide this message', 'w3-total-cache' ),
self::url( $parameters ),
false,
'button',
'w3tc_hide_' . self::config_key_to_http_name( $parameters['key'] )
);
}
/**
* Action button
*
* @param string $action Action.
* @param string $url URL.
* @param string $class_value Class.
* @param bool $new_window New window flag.
*
* @return string
*/
public static function action_button( $action, $url, $class_value = '', $new_window = false ) {
return self::button_link( $action, $url, $new_window, $class_value );
}
/**
* Returns popup button html
*
* @param string $text Text.
* @param string $action Action.
* @param string $params Parameters.
* @param integer $width Width.
* @param integer $height Height.
*
* @return string
*/
public static function button_popup( $text, $action, $params = '', $width = 800, $height = 600 ) {
$url = wp_nonce_url( sprintf( 'admin.php?page=w3tc_dashboard&w3tc_%s%s', $action, ( '' !== $params ? '&' . $params : '' ) ), 'w3tc' );
$url = str_replace( '&', '&', $url );
$onclick = sprintf( 'window.open(\'%s\', \'%s\', \'width=%d,height=%d,status=no,toolbar=no,menubar=no,scrollbars=yes\');', $url, $action, $width, $height );
return self::button( $text, $onclick );
}
/**
* Returns label string for a config key.
*
* @param string $config_key Config key.
*
* @return string
*/
public static function config_label( $config_key ) {
static $config_labels = null;
if ( is_null( $config_labels ) ) {
$config_labels = apply_filters( 'w3tc_config_labels', array() );
}
if ( isset( $config_labels[ $config_key ] ) ) {
return $config_labels[ $config_key ];
}
return '';
}
/**
* Prints the label string for a config key.
*
* @param string $config_key Config key.
*
* @return void
*/
public static function e_config_label( $config_key ) {
$config_label = self::config_label( $config_key );
echo wp_kses(
$config_label,
self::get_allowed_html_for_wp_kses_from_content( $config_label )
);
}
/**
* Returns postbox header
*
* WordPress 5.5 introduced .postbox-header, which broke the styles of our postboxes. This was
* resolved by adding additional css to /pub/css/options.css and pub/css/widget.css tagged with
* a "WP 5.5" comment.
*
* @todo Add .postbox-header to our postboxes and cleanup css.
*
* @link https://github.com/BoldGrid/w3-total-cache/issues/237
*
* @param string $title Title.
* @param string $class_value Class.
* @param string $id ID.
*
* @return void
*/
public static function postbox_header( $title, $class_value = '', $id = '' ) {
$id = ! empty( $id ) ? ' id="' . esc_attr( $id ) . '"' : '';
?>
<div <?php echo wp_kses( $id, self::get_allowed_html_for_wp_kses_from_content( $id ) ); ?> class="postbox <?php echo esc_attr( $class_value ); ?>">
<h3 class="postbox-title">
<span><?php echo wp_kses( $title, self::get_allowed_html_for_wp_kses_from_content( $title ) ); ?></span>
</h3>
<div class="inside">
<?php
}
/**
* Returns postbox header with tabs and links (used on the General settings page exclusively).
*
* WordPress 5.5 introduced .postbox-header, which broke the styles of our postboxes. This was
* resolved by adding additional CSS to `/pub/css/options.css` and `/pub/css/widget.css` tagged with
* a "WP 5.5" comment.
*
* phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
*
* @todo Add .postbox-header to our postboxes and clean up CSS.
*
* @link https://github.com/BoldGrid/w3-total-cache/issues/237
*
* @param string $title The title of the postbox.
* @param string $description Optional. Description of the postbox. Default empty.
* @param string $class_value Optional. Additional CSS class for styling. Default empty.
* @param string $id Optional. HTML ID attribute. Default empty.
* @param string $adv_link Optional. URL for the "Advanced Settings" tab. Default empty.
* @param string $premium_link Optional. URL for the "Premium Services" tab. Default empty.
* @param string $tutorials_tab Optional. URL for the "Help" tab. Default empty.
* @param array $extra_links {
* Optional. Additional links for the postbox navigation.
*
* @type string $text Link text.
* @type string $url URL for the extra link.
* }
*
* @return void
*/
public static function postbox_header_tabs( $title, $description = '', $class_value = '', $id = '', $adv_link = '', $premium_link = '', $tutorials_tab = '', $extra_links = array() ) {
$display_id = ( ! empty( $id ) ) ? ' id="' . esc_attr( $id ) . '"' : '';
$description = ( ! empty( $description ) ) ? '<div class="postbox-description">' . wp_kses( $description, self::get_allowed_html_for_wp_kses_from_content( $description ) ) . '</div>' : '';
$basic_settings_tab = ( ! empty( $adv_link ) ) ? '<a class="w3tc-basic-settings nav-tab nav-tab-active no-link">' . esc_html__( 'Basic Settings', 'w3-total-cache' ) . '</a>' : '';
$adv_settings_tab = ( ! empty( $adv_link ) ) ? '<a class="nav-tab link-tab" href="' . esc_url( $adv_link ) . '" gatitle="' . esc_attr( $id ) . '">' . esc_html__( 'Advanced Settings', 'w3-total-cache' ) . '<span class="dashicons dashicons-arrow-right-alt2"></span></a>' : '';
$premium_link_tab = ( ! empty( $premium_link ) ) ? '<a class="nav-tab link-tab ' . esc_attr( $id ) . '" data-tab-type="premium-services">' . esc_html__( 'Premium Services', 'w3-total-cache' ) . '</a>' : '';
$tutorials_tab = ( ! empty( $premium_link ) ) ? '<a class="nav-tab link-tab ' . esc_attr( $id ) . '" data-tab-type="help">' . esc_html__( 'Help', 'w3-total-cache' ) . '</a>' : '';
$extra_link_tabs = '';
foreach ( $extra_links as $extra_link_text => $extra_link ) {
$extra_link_tabs .= '<a class="nav-tab link-tab" href="' . esc_url( $extra_link ) . '" gatitle="' . esc_attr( $extra_link_text ) . '">' . esc_html( $extra_link_text ) . '</a>';
}
echo '<div' . $display_id . ' class="postbox-tabs ' . esc_attr( $class_value ) . '">
<h3 class="postbox-title"><span>' . wp_kses( $title, self::get_allowed_html_for_wp_kses_from_content( $title ) ) . '</span></h3>
' . $description . '
<h2 class="nav-tab-wrapper">' . $basic_settings_tab . $adv_settings_tab . $premium_link_tab . $tutorials_tab . $extra_link_tabs . '</h2>
<div class="inside">';
}
/**
* Returns postbox footer
*
* @return void
*/
public static function postbox_footer() {
echo '</div></div>';
}
/**
* Retrieves a specific tab's content based on the provided key and tab type.
*
* @since 2.8.3
*
* This function dynamically loads content for a specified tab type (e.g., tutorials, premium services)
* based on a given configuration key. It uses a mapping to fetch the correct tab content, which is then
* wrapped in a `<div>` element with a `data-tab-type` attribute for identification.
*
* @param string $key The configuration key used to retrieve tab settings.
* @param string $tab_type The type of tab to retrieve (e.g., 'tutorials', 'premium-services').
*
* @return string|null The HTML content for the specified tab, or null if the tab or key is not found.
*
* Usage:
* ```
* echo wp_kses_post( Util_Ui::get_tab('example_key', 'tutorials'); // Retrieves the tutorials tab for 'example_key'
* ```
*/
public static function get_tab( string $key, string $tab_type ): ?string {
// If for any reason the key or tab type is empty, return an empty string.
if ( empty( $key ) || empty( $tab_type ) ) {
return '';
}
require_once 'ConfigSettingsTabs.php';
$configs = Config_Tab_Settings::get_config( $key );
// Define a mapping of tab types to the corresponding config keys.
$tab_mapping = array(
'help' => 'help',
'premium-services' => 'premium_support',
);
// Check if the provided tab type exists in the mapping and in the configs.
if ( isset( $tab_mapping[ $tab_type ] ) && isset( $configs['tabs'][ $tab_mapping[ $tab_type ] ] ) ) {
return '<div data-tab-type="' . esc_attr( $tab_type ) . '">' . $configs['tabs'][ $tab_mapping[ $tab_type ] ] . '</div>';
}
return null;
}
/**
* Config save button.
*
* @param string $id ID.
* @param string $extra Extra.
*
* @return void
*/
public static function button_config_save( $id = '', $extra = '' ) {
$b1_id = 'w3tc_save_options_' . $id;
$b2_id = 'w3tc_default_save_and_flush_' . $id;
$nonce_field = self::nonce_field( 'w3tc' );
$nonce_html = wp_kses( $nonce_field, self::get_allowed_html_for_wp_kses_from_content( $nonce_field ) );
$extra_html = wp_kses( $extra, self::get_allowed_html_for_wp_kses_from_content( $extra ) );
?>
<p class="submit">
<?php echo $nonce_html; ?>
<input type="submit" id="<?php echo esc_attr( $b1_id ); ?>" name="w3tc_save_options" class="w3tc-button-save button-primary" value="<?php esc_attr_e( 'Save all settings', 'w3-total-cache' ); ?>" />
<?php echo $extra_html; ?>
<?php
if ( ! is_network_admin() ) {
echo '<input type="submit" id="' . esc_attr( $b2_id ) . '" name="w3tc_default_save_and_flush" style="float: right"
class="w3tc-button-save button-primary" value="' . esc_attr__( 'Save Settings & Purge Caches', 'w3-total-cache' ) . '" />';
}
?>
</p>
<?php
}
/**
* Config save button with dropdown.
*
* @param string $id ID.
* @param string $extra Extra.
*
* @return void
*/
public static function button_config_save_dropdown( $id = '', $extra = '' ) {
?>
<div class="w3tc-button-control-container">
<?php
self::print_save_split_button( $id, $extra );
self::print_flush_split_button();
?>
</div>
<?php
}
/**
* Prints the split button for saving setting.
*
* @param string $id ID value.
* @param string $extra Extra values.
*
* @return void
*/
public static function print_save_split_button( $id = '', $extra = '' ) {
$b1_id = 'w3tc_save_options_' . $id;
$b2_id = 'w3tc_default_save_and_flush_' . $id;
$nonce_field = self::nonce_field( 'w3tc' );
echo wp_kses(
$nonce_field,
self::get_allowed_html_for_wp_kses_from_content( $nonce_field )
);
echo wp_kses(
$extra,
self::get_allowed_html_for_wp_kses_from_content( $extra )
);
?>
<div class="btn-group w3tc-button-save-dropdown">
<?php
if ( ! is_network_admin() ) {
?>
<input type="submit" id="<?php echo esc_attr( $b1_id ); ?>" class="w3tc-button-save btn btn-primary btn-sm" name="w3tc_save_options" value="<?php esc_html_e( 'Save Settings', 'w3-total-cache' ); ?>"/>
<button type="button" class="btn btn-primary btn-sm dropdown-toggle dropdown-toggle-split" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<span class="sr-only">Toggle Dropdown</span>
</button>
<div class="dropdown-menu dropdown-menu-right">
<input type="submit" id="<?php echo esc_attr( $b2_id ); ?>" class="w3tc-button-save dropdown-item" name="w3tc_default_save_and_flush" value="<?php esc_html_e( 'Save Settings & Purge Caches', 'w3-total-cache' ); ?>"/>
</div>
<?php
} else {
?>
<input type="submit" class="w3tc-button-save btn btn-primary btn-sm" name="w3tc_save_options" value="<?php esc_html_e( 'Save Settings', 'w3-total-cache' ); ?>"/>
<?php
}
?>
</div>
<?php
}
/**
* Prints the split button for flushing caches.
*
* @return void
*/
public static function print_flush_split_button() {
$config = Dispatcher::config();
$nonce_field = self::nonce_field( 'w3tc' );
echo wp_kses(
$nonce_field,
self::get_allowed_html_for_wp_kses_from_content( $nonce_field )
);
?>
<div class="btn-group w3tc-button-flush-dropdown">
<input id="flush_all" type="submit" class="btn btn-light btn-sm" name="w3tc_flush_all" value="<?php esc_html_e( 'Empty All Caches', 'w3-total-cache' ); ?>"/>
<button type="button" class="btn btn-light btn-sm dropdown-toggle dropdown-toggle-split" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<span class="sr-only">Toggle Dropdown</span>
</button>
<div class="dropdown-menu dropdown-menu-right">
<?php
$actions = apply_filters( 'w3tc_dashboard_actions', array() );
foreach ( $actions as $action ) {
echo wp_kses(
$action,
array(
'input' => array(
'class' => array(),
'disabled' => array(),
'name' => array(),
'type' => array(),
'value' => array(),
),
)
);
}
if ( $config->get_boolean( 'pgcache.enabled' ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_pgcache" value="' . esc_attr__( 'Empty Page Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->get_boolean( 'browsercache.cssjs.replace' ) || $config->get_boolean( 'browsercache.other.replace' ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_browser_cache" value="' . esc_attr__( 'Empty Browser Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->get_boolean( 'minify.enabled' ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_minify" value="' . esc_attr__( 'Empty Minify Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->get_boolean( 'dbcache.enabled' ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_dbcache" value="' . esc_attr__( 'Empty Database Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->getf_boolean( 'objectcache.enabled' ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_objectcache" value="' . esc_attr__( 'Empty Object Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->get_boolean( 'cdn.enabled' ) || $config->get_boolean( 'cdnfsd.enabled' ) ) {
$disable = ( $config->get_boolean( 'cdn.enabled' ) && Cdn_Util::can_purge_all( $config->get_string( 'cdn.engine' ) ) ) ||
( $config->get_boolean( 'cdnfsd.enabled' ) && Cdn_Util::can_purge_all( $config->get_string( 'cdnfsd.engine' ) ) ) ?
'' : ' disabled="disabled" ';
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_cdn"' . $disable . ' value="' . esc_attr__( 'Empty CDN Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->is_extension_active_frontend( 'fragmentcache' ) && Util_Environment::is_w3tc_pro( $config ) && ! empty( $config->get_string( array( 'fragmentcache', 'engine' ) ) ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_fragmentcache" value="' . esc_attr__( 'Empty Fragment Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->get_boolean( 'varnish.enabled' ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_flush_varnish" value="' . esc_attr__( 'Empty Varnish Cache', 'w3-total-cache' ) . '"/>';
}
if ( $config->is_extension_active_frontend( 'cloudflare' ) ) {
echo '<input type="submit" class="dropdown-item" name="w3tc_cloudflare_flush" value="' . esc_attr__( 'Empty Cloudflare Cache', 'w3-total-cache' ) . '"/>';
}
$opcode_enabled = ( Util_Installed::opcache() || Util_Installed::apc_opcache() );
if ( $opcode_enabled ) {
$disable = $opcode_enabled ? '' : ' disabled="disabled" ';
echo '<input type="submit" class="dropdown-item" name="w3tc_opcache_flush"' . $disable . ' value="' . esc_attr__( 'Empty OpCode Cache', 'w3-total-cache' ) . '"/>';
}
?>
</div>
</div>
<?php
}
/**
* Prints the form control bar
*
* @param string $id ID.
*
* @return void
*/
public static function print_control_bar( $id = '' ) {
?>
<div class="w3tc_form_bar">
<?php
$custom_areas = apply_filters( 'w3tc_settings_general_anchors', array() );
self::print_options_menu( $custom_areas );
self::button_config_save_dropdown( $id );
?>
</div>
<?php
}
/**
* Sealing disabled
*
* @param string $key Key.
*
* @return void
*/
public static function sealing_disabled( $key ) {
$c = Dispatcher::config();
if ( $c->is_sealed( $key ) ) {
echo 'disabled="disabled" ';
}
}
/**
* Returns nonce field HTML
*
* @param string|int $action Action.
* @param string $name Name.
* @param bool $referer Referrer.
*
* @return string
*/
public static function nonce_field( $action = -1, $name = '_wpnonce', $referer = true ) {
$return = '<input type="hidden" name="' . esc_attr( $name ) . '" value="' . esc_attr( wp_create_nonce( $action ) ) . '" />';
if ( $referer ) {
$return .= wp_referer_field( false );
}
return $return;
}
/**
* Returns an notification box
*
* @param string $message Message.
* @param string $id Adds an id to the notification box.
*
* @return string
*/
public static function get_notification_box( $message, $id = '' ) {
$page_val = Util_Request::get_string( 'page' );
if ( empty( $page_val ) || ( ! empty( $page_val ) && 'w3tc_' !== substr( $page_val, 0, 5 ) ) ) {
$logo = sprintf(
'<img src="%s" alt="W3 Total Cache" style="height:30px;padding: 10px 2px 0 2px;" />"',
esc_url( plugins_url( '/pub/img/W3TC_dashboard_logo_title.png', W3TC_FILE ) ) . ''
);
} else {
$logo = '';
}
return sprintf(
'<div %s class="updated inline">%s</div>',
$id ? 'id="' . esc_attr( $id ) . '"' : '',
$logo . wp_kses( $message, self::get_allowed_html_for_wp_kses_from_content( $message ) )
);
}
/**
* Echos an notification box
*
* @param string $message Message.
* @param string $id adds an id to the notification box.
*
* @return void
*/
public static function e_notification_box( $message, $id = '' ) {
$notification_box = self::get_notification_box( $message, $id );
echo wp_kses(
$notification_box,
self::get_allowed_html_for_wp_kses_from_content( $notification_box )
);
}
/**
* Echos an error box.
*
* @param string $message Message.
* @param string $id Id.
*
* @return void
*/
public static function error_box( $message, $id = '' ) {
$page_val = Util_Request::get_string( 'page' );
if ( empty( $page_val ) || ( ! empty( $page_val ) && 'w3tc_' !== substr( $page_val, 0, 5 ) ) ) {
$logo = sprintf(
'<img src="%s" alt="W3 Total Cache" style="height:30px;padding: 10px 2px 0 2px;" />',
esc_url( plugins_url( '/pub/img/W3TC_dashboard_logo_title.png', W3TC_FILE ) . '' )
);
} else {
$logo = '';
}
$v = sprintf(
'<div %s class="error inline">%s</div>',
$id ? 'id="' . esc_attr( $id ) . '"' : '',
$logo . wp_kses( $message, self::get_allowed_html_for_wp_kses_from_content( $message ) )
);
echo wp_kses(
$v,
self::get_allowed_html_for_wp_kses_from_content( $v )
);
}
/**
* Format bytes into B, KB, MB, GB and TB
*
* phpcs:disable Squiz.PHP.CommentedOutCode.Found
*
* @param int $bytes Bytes.
* @param int $precision Precision.
*
* @return string
*/
public static function format_bytes( $bytes, $precision = 2 ) {
$units = array( 'B', 'KB', 'MB', 'GB', 'TB' );
$bytes = max( $bytes, 0 );
$pow = floor( ( $bytes ? log( $bytes ) : 0 ) / log( 1024 ) );
$pow = min( $pow, count( $units ) - 1 );
// Uncomment one of the following alternatives.
$bytes /= pow( 1024, $pow );
// $bytes /= ( 1 << ( 10 * $pow ) );
return round( $bytes, $precision ) . ' ' . $units[ $pow ];
}
/**
* Format mbytes into B, KB, MB, GB and TB
*
* phpcs:disable Squiz.PHP.CommentedOutCode.Found
*
* @param int $bytes Bytes.
* @param int $precision Precision.
*
* @return string
*/
public static function format_mbytes( $bytes, $precision = 2 ) {
$units = array( 'B', 'KB', 'MB', 'GB', 'TB' );
$bytes = max( $bytes, 0 );
$pow = floor( ( $bytes ? log( $bytes ) : 0 ) / log( 1024 ) );
$pow = min( $pow, count( $units ) - 1 );
// Uncomment one of the following alternatives.
$bytes /= pow( 1024, $pow );
// $bytes /= ( 1 << ( 10 * $pow ) );
return round( $bytes, $precision ) . ' ' . $units[ $pow + 2 ];
}
/**
* Returns an hidden input text element
*
* @param string $id ID.
* @param string $name Name.
* @param string $value Value.
*
* @return string
*/
public static function r_hidden( $id, $name, $value ) {
return '<input type="hidden" id="' . esc_attr( $id ) . '" name="' . esc_attr( $name ) . '" value="' . esc_attr( $value ) . '" />';
}
/**
* Echos a hidden input text element
*
* @param string $id ID.
* @param string $name Name.
* @param string $value Value.
*
* @return void
*/
public static function hidden( $id, $name, $value ) {
$hidden = self::r_hidden( $id, $name, $value );
echo wp_kses(
$hidden,
self::get_allowed_html_for_wp_kses_from_content( $hidden )
);
}
/**
* Echos an label element
*
* @param string $id ID.
* @param string $text Text.
*
* @return void
*/
public static function label( $id, $text ) {
$label = '<label for="' . esc_attr( $id ) . '">' . $text . '</label>';
echo wp_kses(
$label,
self::get_allowed_html_for_wp_kses_from_content( $label )
);
}
/**
* Echos an input text element
*
* @param string $id ID.
* @param string $name Name.
* @param string $value Value.
* @param bool $disabled Disabled.
* @param int $size Size.
* @param string $type Type.
* @param string $placeholder Placeholder.
*
* @return void
*/
public static function textbox( $id, $name, $value, $disabled = false, $size = 40, $type = 'text', $placeholder = '' ) {
$placeholder = ! empty( $placeholder ) ? ' placeholder="' . esc_attr( $placeholder ) . '"' : '';
echo '<input class="enabled" type="' . esc_attr( $type ) . '" id="' . esc_attr( $id ) . '" name="' . esc_attr( $name ) . '"
value="' . esc_attr( $value ) . '" ' . disabled( $disabled, true, false ) . ' size="' . esc_attr( $size ) . '"' . $placeholder . ' />';
}
/**
* Echos an input password element
*
* @param string $id ID.
* @param string $name Name.
* @param string $value Value.
* @param bool $disabled Diabled.
* @param int $size Size.
*
* @return void
*/
public static function passwordbox( $id, $name, $value, $disabled = false, $size = 40 ) {
echo '<input class="enabled" type="password" id="' . esc_attr( $id ) . '" name="' . esc_attr( $name ) . '"
value="' . esc_attr( $value ) . '" ' . disabled( $disabled, true, false ) . ' size="' . esc_attr( $size ) . '" />';
}
/**
* Echoes a select element.
*
* @param string $id The ID attribute for the select element.
* @param string $name The name attribute for the select element.
* @param string $value The selected value.
* @param array $values An array of options, where the key is the option value and the value is the label.
* @param bool $disabled Whether the select element should be disabled. Default false.
* @param array $optgroups {
* Optional. An associative array of optgroup labels.
*
* @type int|string $key The optgroup identifier.
* @type string $label The label for the optgroup.
* }
*
* @return void
*/
public static function selectbox( $id, $name, $value, $values, $disabled = false, $optgroups = null ) {
echo '<select id="' . esc_attr( $id ) . '" name="' . esc_attr( $name ) . '" ' . disabled( $disabled, true, false ) . ">\n";
if ( ! is_array( $optgroups ) ) {
// simle control.
foreach ( $values as $key => $descriptor ) {
self::option( $key, $value, $descriptor );
}
} else {
// with optgroups.
$current_optgroup = -1;
foreach ( $values as $key => $descriptor ) {
$optgroup = ( isset( $descriptor['optgroup'] ) ? $descriptor['optgroup'] : -1 );
if ( $optgroup !== $current_optgroup ) {
if ( -1 !== $current_optgroup ) {
echo '</optgroup>';
}
echo '<optgroup label="' . esc_attr( $optgroups[ $optgroup ] ) . '">' . "\n";
$current_optgroup = $optgroup;
}
self::option( $key, $value, $descriptor );
}
if ( -1 !== $current_optgroup ) {
echo '</optgroup>';
}
}
echo '</select>';
}
/**
* Echos a select option
*
* @param string $key Key.
* @param string $selected_value Name.
* @param string $descriptor Descriptor.
*
* @return void
*/
private static function option( $key, $selected_value, $descriptor ) {
if ( ! is_array( $descriptor ) ) {
$label = $descriptor;
$disabled = false;
} else {
$label = $descriptor['label'];
$disabled = ! empty( $descriptor['disabled'] );
}
echo '<option value="' . esc_attr( $key ) . '" ' . selected( $selected_value, $key ) . disabled( $disabled, true, false ) . '>' .
wp_kses( $label, self::get_allowed_html_for_wp_kses_from_content( $label ) ) . '</option>' . "\n";
}
/**
* Echos a group of radio elements values: value => label pair or value => array(label, disabled, postfix).
*
* @param string $name Name.
* @param string $value Value.
* @param array $values {
* Values.
*
* @type string $label Label for the radio button.
* @type bool $disabled Whether the radio button is disabled.
* @type string $postfix Postfix to be appended to the label.
* @type bool $pro_feature Whether the radio button is a pro feature.
* @type string $pro_excerpt Excerpt for pro feature description.
* @type string $pro_description Full description for the pro feature.
* @type string $intro_label Intro label for pro feature.
* @type string $score Score associated with the pro feature.
* @type string $score_label Label for the score.
* @type string $score_description Description for the score.
* @type string $score_link Link related to the score.
* @type bool $show_learn_more Whether to show the "learn more" option for the pro feature.
* }
* @param bool $disabled Disabled flag for all radio buttons.
* @param string $separator Separator to be used between radio buttons.
*
* @return void
*/
public static function radiogroup( $name, $value, $values, $disabled = false, $separator = '' ) {
$c = Dispatcher::config();
$is_pro = Util_Environment::is_w3tc_pro( $c );
$first = true;
foreach ( $values as $key => $label_or_array ) {
if ( $first ) {
$first = false;
} else {
echo wp_kses(
$separator,
self::get_allowed_html_for_wp_kses_from_content( $separator )
);
}
$label = '';
$item_disabled = false;
$postfix = '';
$pro_feature = false;
if ( ! is_array( $label_or_array ) ) {
$label = $label_or_array;
} else {
$label = $label_or_array['label'];
$item_disabled = $label_or_array['disabled'];
$postfix = isset( $label_or_array['postfix'] ) ? $label_or_array['postfix'] : '';
$pro_feature = isset( $label_or_array['pro_feature'] ) ? $label_or_array['pro_feature'] : false;
}
if ( $pro_feature ) {
self::pro_wrap_maybe_start();
}
echo '<label><input type="radio" id="' . esc_attr( $name . '__' . $key ) . '" name="' . esc_attr( $name ) .
'" value="' . esc_attr( $key ) . '"' . checked( $value, $key, false ) . disabled( $disabled || $item_disabled, true, false ) . ' />' .
wp_kses( $label, self::get_allowed_html_for_wp_kses_from_content( $label ) ) . '</label>' .
wp_kses( $postfix, self::get_allowed_html_for_wp_kses_from_content( $postfix ) ) . "\n";
if ( $pro_feature ) {
self::pro_wrap_description(
$label_or_array['pro_excerpt'],
$label_or_array['pro_description'],
$name . '__' . $key
);
if ( ! $is_pro && isset( $label_or_array['intro_label'] ) && isset( $label_or_array['score'] ) && isset( $label_or_array['score_label'] ) && isset( $label_or_array['score_description'] ) && isset( $label_or_array['score_link'] ) ) {
$score_block = self::get_score_block( $label_or_array['intro_label'], $label_or_array['score'], $label_or_array['score_label'], $label_or_array['score_description'], $label_or_array['score_link'] );
echo wp_kses( $score_block, self::get_allowed_html_for_wp_kses_from_content( $score_block ) );
}
$show_learn_more = isset( $label_or_array['show_learn_more'] ) && is_bool( $label_or_array['show_learn_more'] ) ? $label_or_array['show_learn_more'] : true;
self::pro_wrap_maybe_end( $name . '__' . $key, $show_learn_more );
}
}
}
/**
* Echos an input text element
*
* @param string $id ID.
* @param string $name Name.
* @param string $value Value.
* @param bool $disabled Disabled.
*
* @return void
*/
public static function textarea( $id, $name, $value, $disabled = false ) {
?>
<textarea class="enabled" id="<?php echo esc_attr( $id ); ?>" name="<?php echo esc_attr( $name ); ?>" rows="5" cols=25 style="width: 100%" <?php disabled( $disabled, true, true ); ?>>
<?php echo esc_textarea( $value ); ?>
</textarea>
<?php
}
/**
* Echos an input checkbox element
*
* @param string $id ID.
* @param string $name Name.
* @param bool $state Whether checked or not.
* @param bool $disabled Disabled.
* @param string $label Label.
*
* @return void
*/
public static function checkbox( $id, $name, $state, $disabled = false, $label = null ) {
if ( ! is_null( $label ) ) {
echo '<label>';
}
echo '<input type="hidden" name="' . esc_attr( $name ) . '" value="' . esc_attr( ( ! $disabled ? '0' : ( $state ? '1' : '0' ) ) ) . '">' . "\n";
echo '<input class="enabled" type="checkbox" id="' . esc_attr( $id ) . '" name="' . esc_attr( $name ) .
'" value="1" ' . checked( $state, true, false ) . disabled( $disabled, true, false ) . ' /> ';
if ( ! is_null( $label ) ) {
echo wp_kses( $label, self::get_allowed_html_for_wp_kses_from_content( $label ) ) . '</label>';
}
}
/**
* Echos an element
*
* @param string $type Type.
* @param string $id ID.
* @param string $name Name.
* @param mixed $value Value.
* @param bool $disabled Disabled.
*
* @return void
*/
public static function element( $type, $id, $name, $value, $disabled = false ) {
switch ( $type ) {
case 'textbox':
self::textbox( $id, $name, $value, $disabled );
break;
case 'password':
self::passwordbox( $id, $name, $value, $disabled );
break;
case 'textarea':
self::textarea( $id, $name, $value, $disabled );
break;
case 'checkbox':
default:
self::checkbox( $id, $name, $value, $disabled );
break;
}
}