forked from ahmadawais/WP-OOP-Settings-API
-
Notifications
You must be signed in to change notification settings - Fork 0
/
class-wp-settings-kit.php
1358 lines (1205 loc) · 39.8 KB
/
class-wp-settings-kit.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
/**
* This file is part of Wp Settings Kit, a fork of "WP-OOP-Settings-API" maintained by "Rahal Aboulfeth".
* "WP-OOP-Settings-API" was created by ( Ahmad Awais :@MrAhmadAwais ) and is licensed under GNU GENERAL PUBLIC Version 2 LICENSE].
* This fork includes additional features and improvements by "Rahal Aboulfeth". and is released under the same license (GPL2).
*
* @copyright Copyright (c) 2023 Rahal Aboulfeth
* @license GPL2
*
* @package WP_SKIT_VERSION
* @version '1.1.4'
*/
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* WP_Settings_Kit.
*
* WP Settings Kit Class.
*
* @since 1.0.0
*/
if ( ! class_exists( 'WP_Settings_Kit' ) ) :
define( 'WP_SKIT_VERSION', '1.1.4' );
/**
* Main WP Settings Kit class
*/
class WP_Settings_Kit {
/**
* Sections array.
*
* @var array
* @since 1.0.0
*/
private $sections_array = array();
/**
* Fields array.
*
* @var array
* @since 1.0.0
*/
private $fields_array = array();
/**
* Metabox options
*
* @var ?array
*/
private $metabox = null;
/**
* Options
*
* @var array
*/
private $options = null;
/**
* Setting name : will affect the hook name setting_ready
*
* @var string
* @since 1.0.0
*/
protected $settings_name = null;
/**
* Constructs a new instance.
*
* @param ?array $options The options.
* @param ?array $metabox The metabox.
* @since 1.0.0
*/
public function __construct( $options = null, $metabox = null ) {
$this->options = $options;
if ( $metabox ) {
// Use for post metabox.
$this->metabox = $metabox;
add_action( 'add_meta_boxes', array( $this, 'add_metabox' ) );
add_action( 'save_post', array( $this, 'save_metabox' ), 10, 2 );
} else {
$this->init_consts();
if ( is_admin() ) {
// Enqueue the admin scripts.
add_action( 'admin_enqueue_scripts', array( $this, 'admin_scripts' ) );
// Hook it up.
add_action( 'admin_init', array( $this, 'admin_init' ) );
// Menu.
add_action( 'admin_menu', array( $this, 'admin_menu' ) );
$this->init_options();
}
// To allow multiple instanciations off this class.
if ( $this->settings_name ) {
do_action( 'settings_ready_' . $this->settings_name );
} else {
do_action( 'settings_ready' );
}
}
}
/**
* Should we show the field or the section.
*
* @param array $field_or_section The field or section config array.
*
* @return bool should show
*/
protected function should_show( array $field_or_section ) {
if ( isset( $field_or_section['show_if'] ) && is_callable( $field_or_section['show_if'] ) ) {
return $field_or_section['show_if']();
}
return true;
}
/**
* Initializes the sections and fields.
*/
public function init_options() {
foreach ( $this->options as $section ) {
if ( ! $this->should_show( $section ) ) {
continue;
}
$name = $title = $fields = $show_if = $description = $side_panel = null;
extract( $section );
$this->add_section(
array(
'id' => $name,
'title' => $title,
'show_if' => $show_if,
'desc' => $description,
'side_panel' => $side_panel,
)
);
if ( $fields ) {
foreach ( $fields as $field ) {
if ( ! $this->should_show( $field ) ) {
continue;
}
$this->add_field( $name, $field );
}
}
}
}
/**
* Defines the constants from the saved options or from the fields default values if options are not saved.
*/
public function init_consts() {
foreach ( $this->options as $section ) {
$options = get_option( $section['name'] );
if ( $options ) {
foreach ( $options as $key => $value ) {
$option_name = $section['name'] . '_' . $key;
if ( ! defined( $option_name ) ) {
define( $option_name, $value );
}
}
}
// init from default if constant is not defined.
foreach ( $section['fields'] as $field ) {
$option_name = $section['name'] . '_' . $field['id'];
if ( ! defined( $option_name ) && array_key_exists( 'default', $field ) ) {
define( $option_name, $field['default'] );
}
}
}
}
/**
* Admin Scripts.
*
* @since 1.0.0
*/
public function admin_scripts() {
// jQuery is needed.
wp_enqueue_script( 'jquery' );
// Color Picker.
wp_enqueue_script(
'iris',
admin_url( 'js/iris.min.js' ),
array( 'jquery-ui-draggable', 'jquery-ui-slider', 'jquery-touch-punch' ),
true,
true
);
// Media Uploader.
wp_enqueue_media();
}
/**
* Set Sections.
*
* @param array $sections Sections.
* @since 1.0.0
*/
public function set_sections( array $sections ) {
// Assign to the sections array.
$this->sections_array = $sections;
return $this;
}
/**
* Add a single section.
*
* @param array $section Section Config.
* @since 1.0.0
*/
public function add_section( array $section ) {
// Assign the section to sections array.
$this->sections_array[] = $section;
return $this;
}
/**
* Set Fields.
*
* @param array $fields Fields Config.
* @since 1.0.0
*/
public function set_fields( array $fields ) {
// Assign the fields.
$this->fields_array = $fields;
return $this;
}
/**
* Default field configuration
*
* @var array
*/
public const DEFAULT_FIELD = array(
'id' => '',
'name' => 'No name',
'desc' => '',
'type' => 'text',
'label_for' => null,
'default' => null,
'std' => null,
'size' => null,
'options' => null,
'query' => null,
'callback' => null,
'placeholder' => null,
'sanitize_callback' => null,
'sanitization_error_message' => null,
);
/**
* Adds a single field.
*
* @param string $section_id The section Id.
* @param array $field_array The field array.
* @since 1.0.0
*
* @return self self to allow chainning
*/
public function add_field( $section_id, array $field_array ) {
// Combine the defaults with user's arguements.
$field_array['section'] = $section_id;
if ( isset( $field_array['default'] ) ) {
$field_array['std'] = $field_array['default'];
}
if ( isset( $field_array['title'] ) ) {
$field_array['name'] = $field_array['title'];
}
if ( isset( $field_array['description'] ) ) {
$field_array['desc'] = $field_array['description'];
}
$field_array['label_for'] = "{$section_id}[{$field_array['id']}]";
$arg = wp_parse_args( $field_array, self::DEFAULT_FIELD );
// Each field is an array named against its section.
$this->fields_array[ $section_id ][] = $arg;
return $this;
}
/**
* Initialize API.
*
* Initializes and registers the settings sections and fields.
* Usually this should be called at `admin_init` hook.
*
* @since 1.0.0
*/
public function admin_init() {
/**
* Register the sections.
*
* Sections array is like this:
*
* $sections_array = array (
* $section_array,
* $section_array,
* $section_array,
* );
*
* Section array is like this:
*
* $section_array = array (
* 'id' => 'section_id',
* 'title' => 'Section Title',
* 'desc' => 'Section Description'
* );
*
* @since 1.0.0
*/
foreach ( $this->sections_array as $section ) {
if ( false === get_option( $section['id'] ) ) {
// Add a new field as section ID.
add_option( $section['id'] );
}
// Deals with sections description.
if ( isset( $section['desc'] ) && ! empty( $section['desc'] ) ) {
// Create the callback for description.
$callback = function () use ( $section ) {
echo '<div class="inside">' . wp_kses_post( $section['desc'] ) . '</div>';
};
} elseif ( isset( $section['callback'] ) ) {
$callback = $section['callback'];
} else {
$callback = null;
}
/**
* Add a new section to a settings page.
*
* @param string $id
* @param string $title
* @param callable $callback
* @param string $page | Page is same as section ID.
* @since 1.0.0
*/
add_settings_section( $section['id'], $section['title'], $callback, $section['id'] );
} // foreach ended.
/**
* Register settings fields.
*
* Fields array is like this:
*
* $fields_array = array (
* $section => $field_array,
* $section => $field_array,
* $section => $field_array,
* );
*
*
* Field array is like this:
*
* $field_array = array (
* 'id' => 'id',
* 'name' => 'Name',
* 'type' => 'text',
* );
*
* @since 1.0.0
*/
foreach ( $this->fields_array as $section => $field_array ) {
foreach ( $field_array as $field ) {
/**
* Add a new field to a section of a settings page.
*
* @param string $id
* @param string $title
* @param callable $callback
* @param string $page
* @param string $section = 'default'
* @param array $args = array()
* @since 1.0.0
*/
// @param string $id
$field_id = $section . '[' . $field['id'] . ']';
$type = $field['type'];
$name = $field['name'];
add_settings_field(
$field_id,
$name,
array( $this, 'callback_' . $type ),
$section,
$section,
$field
);
} // foreach ended.
} // foreach ended.
// Creates our settings in the fields table.
foreach ( $this->sections_array as $section ) {
$section_id = $section['id'];
/**
* Registers a setting and its sanitization callback.
*
* @param string $field_group | A settings group name.
* @param string $field_name | The name of an option to sanitize and save.
* @param callable $sanitize_callback = ''
* @since 1.0.0
*/
register_setting(
$section_id,
$section_id,
function ( $fields ) use ( $section_id ) {
return $this->sanitize_fields( $fields, $section_id );
}
);
} // foreach ended.
} // admin_init() ended.
/**
* Default sanitization error message, highly recommanded to be overriden to support translation
*
* @param array $field_config The field configuration.
*
* @return string The localized error message.
*/
public function default_sanitization_error_message( array $field_config ) {
/* translators: 1: the field name */
return sprintf( __( 'Please insert a valid %s' ), $field_config['type'] );
}
/**
* Gets the sanitizer function
*
* @param array $field_config The field configuration.
*
* @return <type> The sanitizer.
*/
protected function get_sanitizer( array $field_config ) {
if ( isset( $field_config['sanitize_callback'] ) && is_callable( $field_config['sanitize_callback'] ) ) {
return $field_config['sanitize_callback'];
}
return function ( $field_value ) use ( $field_config ) {
return $this->sanitize_field( $field_value, $field_config );
};
}
/**
* Gets the error message.
*
* @param array $field_config The field configuration.
*
* @return string The error message.
*/
protected function get_error_message( array $field_config ) {
if ( isset( $field_config['sanitization_error_message'] ) ) {
return $field_config['sanitization_error_message'];
}
return $this->default_sanitization_error_message( $field_config );
}
/**
* Sanitize callback for Settings API fields.
*
* @param array $fields The fields.
* @param string $section_id The section identifier.
*
* @return array The sanitized fields.
*/
public function sanitize_fields( array $fields, $section_id ) {
$old_values = get_option( $section_id, array() );
foreach ( $fields as $field_slug => $field_value ) {
if ( ! empty( $field_value ) ) {
$field_config = $this->get_field_config( $section_id, $field_slug );
if ( $field_config ) {
// Use sanitizer from field config, if not provided, use internal sanitization.
$sanitize_callback = $this->get_sanitizer( $field_config );
$sanitized = call_user_func( $sanitize_callback, $field_value );
if ( empty( $sanitized ) ) {
add_settings_error(
$section_id,
$section_id . '[' . $field_slug . ']', // so we can easily access the field ( see script method sanitization errors ).
$this->get_error_message( $field_config ),
'error'
);
if ( isset( $old_values[ $field_slug ] ) ) {
// Get the old value.
$sanitized = $old_values[ $field_slug ];
}
}
$fields[ $field_slug ] = $sanitized;
}
}
}
return $fields;
}
/**
* General Sanitize callback for a field, uses the field config to get the type of field
*
* @param string $field_value The field value.
* @param array $field_config The field configuration.
*
* @return mixed The sanitized field
*/
public function sanitize_field( $field_value, $field_config ) {
$type = $field_config['type'];
switch ( $type ) {
case 'checkbox':
return 'on' === $field_value ? 'on' : 'off';
case 'range':
case 'number':
if ( is_numeric( $field_value ) ) {
return $field_value;
}
return 0;
case 'textarea':
return wp_kses_post( $field_value );
case 'email':
return sanitize_email( $field_value );
case 'url':
return esc_url_raw( $field_value );
default:
if ( ! empty( $field_value ) ) {
return sanitize_text_field( $field_value );
}
return '';
}
}
/**
* Gets the field configuration.
*
* @param string $section_id The section identifier.
* @param string $field_slug The field slug.
*
* @return array The field configuration or null.
*/
public function get_field_config( $section_id, $field_slug ) {
foreach ( $this->fields_array[ $section_id ] as $field ) {
if ( $field['id'] === $field_slug ) {
return $field;
}
}
return null;
}
/**
* Get field description for display.
*
* @param array $args settings field args.
*/
public function get_field_description( array $args ) {
if ( ! empty( $args['desc'] ) ) {
$desc = sprintf( '<p class="description">%s</p>', wp_kses_post( $args['desc'] ) );
} else {
$desc = '';
}
return $desc;
}
/**
* Displays a text field for a settings field
*
* @param array $args settings field args.
*/
public function callback_text( array $args ) {
$value = $this->get_option( $args['id'], $args['section'], $args['std'], $args['placeholder'] );
$size = ( isset( $args['size'] ) && ! is_null( $args['size'] ) ) ? $args['size'] : 'regular';
$type = isset( $args['type'] ) ? $args['type'] : 'text';
$attributes = isset( $args['attributes'] ) && is_array( $args['attributes'] ) ? wp_sanitize_script_attributes( $args['attributes'] ) : '';
$after = isset( $args['after'] ) ? $args['after'] : '';
$html_safe = sprintf( '<input type="%1$s" class="%2$s-text" id="%3$s[%4$s]" name="%3$s[%4$s]" value="%5$s" placeholder="%6$s" %7$s /> %8$s', $type, $size, $args['section'], $args['id'], esc_attr( $value ), esc_attr( $args['placeholder'] ), $attributes, $after );
$html_safe .= $this->get_field_description( $args );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo $html_safe;
}
/**
* Displays a url field for a settings field
*
* @param array $args settings field args.
*/
public function callback_url( array $args ) {
$this->callback_text( $args );
}
/**
* Displays a date field for a settings field
*
* @param array $args settings field args.
*/
public function callback_date( array $args ) {
$this->callback_text( $args );
}
/**
* Displays an email field for a settings field
*
* @param array $args settings field args.
*/
public function callback_email( array $args ) {
$this->callback_text( $args );
}
/**
* Displays a number field for a settings field
*
* @param array $args settings field args.
*/
public function callback_number( array $args ) {
$this->callback_text( $args );
}
/**
* Displays a range field for a settings field
*
* @param array $args settings field args.
*/
public function callback_range( array $args ) {
$value = esc_html( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$args['after'] = "<output>$value</output>";
if ( ! isset( $args['attributes'] ) || ! is_array( $args['attributes'] ) ) {
$args['attributes'] = array();
}
$args['attributes']['oninput'] = 'this.nextElementSibling.value = this.value';
$this->callback_text( $args );
}
/**
* Displays a checkbox for a settings field
*
* @param array $args settings field args.
*/
public function callback_checkbox( array $args ) {
$value = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$section_escaped = esc_attr( $args['section'] );
$id_escaped = esc_attr( $args['id'] );
$html_safe = '<fieldset>';
$html_safe .= sprintf( '<label for="wposa-%1$s[%2$s]">', $section_escaped, $id_escaped );
$html_safe .= sprintf( '<input type="hidden" name="%1$s[%2$s]" value="off" />', $section_escaped, $id_escaped );
$html_safe .= sprintf( '<input type="checkbox" class="checkbox" id="wposa-%1$s[%2$s]" name="%1$s[%2$s]" value="on" %3$s />', $section_escaped, $id_escaped, checked( $value, 'on', false ) );
$html_safe .= sprintf( '%1$s</label>', $args['desc'] );
$html_safe .= '</fieldset>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a multicheckbox a settings field
*
* @param array $args settings field args.
*/
public function callback_multicheck( $args ) {
$value = $this->get_option( $args['id'], $args['section'], $args['std'] );
$html_safe = '<fieldset>';
$section_escaped = esc_attr( $args['section'] );
$id_escaped = esc_attr( $args['id'] );
foreach ( $args['options'] as $key => $label ) {
$checked = isset( $value[ $key ] ) ? $value[ $key ] : '0';
$html_safe .= sprintf( '<label for="wposa-%1$s[%2$s][%3$s]">', $section_escaped, $id_escaped, $key );
$html_safe .= sprintf( '<input type="checkbox" class="checkbox" id="wposa-%1$s[%2$s][%3$s]" name="%1$s[%2$s][%3$s]" value="%3$s" %4$s />', $section_escaped, $id_escaped, $key, checked( $checked, $key, false ) );
$html_safe .= sprintf( '%1$s</label><br>', wp_kses_post( $label ) );
}
$html_safe .= $this->get_field_description( $args );
$html_safe .= '</fieldset>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a multicheckbox a settings field
*
* @param array $args settings field args.
*/
public function callback_radio( $args ) {
$value = $this->get_option( $args['id'], $args['section'], $args['std'] );
$html_safe = '<fieldset>';
$section_escaped = esc_attr( $args['section'] );
$id_escaped = esc_attr( $args['id'] );
foreach ( $args['options'] as $key => $label ) {
$html_safe .= sprintf( '<label for="wposa-%1$s[%2$s][%3$s]">', $section_escaped, $id_escaped, $key );
$html_safe .= sprintf( '<input type="radio" class="radio" id="wposa-%1$s[%2$s][%3$s]" name="%1$s[%2$s]" value="%3$s" %4$s />', $section_escaped, $id_escaped, $key, checked( $value, $key, false ) );
$html_safe .= sprintf( '%1$s</label><br>', wp_kses_post( $label ) );
}
$html_safe .= $this->get_field_description( $args );
$html_safe .= '</fieldset>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a selectbox for a settings field
*
* @param array $args settings field args.
*/
public function callback_select( array $args ) {
$value = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$size = isset( $args['size'] ) && ! is_null( $args['size'] ) ? $args['size'] : 'regular';
$html_safe = sprintf( '<select class="%1$s" name="%2$s[%3$s]" id="%2$s[%3$s]">', $size, $args['section'], $args['id'] );
$options = isset( $args['options'] ) ? $args['options'] : array();
if ( isset( $args['query'] ) && isset( $args['query']['type'] ) && 'callback' === $args['query']['type'] ) {
if ( isset( $args['query']['function'] ) && is_callable( $args['query']['function'] ) ) {
$query_args = isset( $args['query']['args'] ) ? $args['query']['args'] : array();
$options = call_user_func( $args['query']['function'], $query_args );
}
}
foreach ( $options as $key => $label ) {
if ( is_array( $label ) ) {
$desc = isset( $label['description'] ) ? $label['description'] : '';
$label = isset( $label['label'] ) ? $label['label'] : $key;
$html_safe .= sprintf( '<option title="%s" value="%s" %s>%s</option>', esc_attr( $desc ), esc_attr( $key ), selected( $value, $key, false ), esc_html( $label ) );
} else {
$html_safe .= sprintf( '<option value="%s"%s>%s</option>', esc_attr( $key ), selected( $value, $key, false ), esc_html( $label ) );
}
}
$html_safe .= sprintf( '</select>' );
$html_safe .= $this->get_field_description( $args );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a textarea for a settings field
*
* @param array $args settings field args.
*/
public function callback_textarea( $args ) {
$value_escaped = esc_textarea( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$size = isset( $args['size'] ) && ! is_null( $args['size'] ) ? $args['size'] : 'regular';
$html_safe = sprintf( '<textarea rows="5" cols="55" class="%1$s-text" id="%2$s[%3$s]" name="%2$s[%3$s]" placeholder="%5$s">%4$s</textarea>', esc_attr( $size ), esc_attr( $args['section'] ), esc_attr( $args['id'] ), $value_escaped, esc_attr( $args['placeholder'] ) );
$html_safe .= $this->get_field_description( $args );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a textarea for a settings field
*
* @param array $args settings field args.
*/
public function callback_html( $args ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $this->get_field_description( $args );
}
/**
* Displays a content ( generate via callback )
*
* @param array $args settings field args.
*/
public function callback_content( $args ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $this->get_field_description( $args );
if ( isset( $args['callback'] ) ) {
$callback = $args['callback'];
if ( isset( $callback['function'] ) && is_callable( $callback['function'] ) ) {
$args = ( isset( $callback['args'] ) ) ? $callback['args'] : '';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- The developper has the responsibility to ensure it's content is safe
echo call_user_func( $callback['function'], $args );
} else {
echo 'Error wrong callback';
}
}
}
/**
* Displays a rich text textarea for a settings field
*
* @param array $args settings field args.
*/
public function callback_wysiwyg( $args ) {
$value = $this->get_option( $args['id'], $args['section'], $args['std'] );
$size = isset( $args['size'] ) && ! is_null( $args['size'] ) ? esc_attr( $args['size'] ) : '500px';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo '<div style="max-width: ' . $size . ';">';
$editor_settings = array(
'teeny' => true,
'textarea_name' => $args['section'] . '[' . $args['id'] . ']',
'textarea_rows' => 10,
);
if ( isset( $args['options'] ) && is_array( $args['options'] ) ) {
$editor_settings = array_merge( $editor_settings, $args['options'] );
}
wp_editor( $value, $args['section'] . '-' . $args['id'], $editor_settings );
echo '</div>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $this->get_field_description( $args );
}
/**
* Displays a file upload field for a settings field
*
* @param array $args settings field args.
*/
public function callback_file( $args ) {
$value_escaped = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$size = isset( $args['size'] ) && ! is_null( $args['size'] ) ? $args['size'] : 'regular';
$label = isset( $args['options']['button_label'] ) ?
$args['options']['button_label'] :
__( 'Choose File' );
$html_safe = sprintf( '<input type="text" class="%1$s-text wpsa-url" id="%2$s[%3$s]" name="%2$s[%3$s]" value="%4$s"/>', esc_attr( $size ), esc_attr( $args['section'] ), esc_attr( $args['id'] ), $value_escaped );
$html_safe .= '<input type="button" class="button wpsa-browse" value="' . esc_attr( $label ) . '" />';
$html_safe .= $this->get_field_description( $args );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays an image upload field with a preview
*
* @param array $args settings field args.
*/
public function callback_image( $args ) {
$value_escaped = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$size = isset( $args['size'] ) && ! is_null( $args['size'] ) ? $args['size'] : 'regular';
$label = isset( $args['options']['button_label'] ) ?
$args['options']['button_label'] :
__( 'Choose Image' );
$html_safe = sprintf( '<input type="text" class="%1$s-text wpsa-url" id="%2$s[%3$s]" name="%2$s[%3$s]" value="%4$s"/>', $size, esc_attr( $args['section'] ), esc_attr( $args['id'] ), $value_escaped );
$html_safe .= '<input type="button" class="button wpsa-browse" value="' . esc_attr( $label ) . '" />';
$html_safe .= $this->get_field_description( $args );
$html_safe .= '<p class="wpkit-image-preview"><img src=""/></p>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a password field for a settings field
*
* @param array $args settings field args.
*/
public function callback_password( $args ) {
$value_escapted = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$size = isset( $args['size'] ) && ! is_null( $args['size'] ) ? $args['size'] : 'regular';
$html_safe = sprintf( '<input type="password" class="%1$s-text" id="%2$s[%3$s]" name="%2$s[%3$s]" value="%4$s"/>', esc_attr( $size ), esc_attr( $args['section'] ), esc_attr( $args['id'] ), $value_escapted );
$html_safe .= $this->get_field_description( $args );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a color picker field for a settings field
*
* @param array $args settings field args.
*/
public function callback_color( $args ) {
$value_escaped = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'], $args['placeholder'] ) );
$size = isset( $args['size'] ) && ! is_null( $args['size'] ) ? $args['size'] : 'regular';
$html_safe = sprintf( '<input type="text" class="%1$s-text color-picker" id="%2$s[%3$s]" name="%2$s[%3$s]" value="%4$s" data-default-color="%5$s" placeholder="%6$s" />', esc_attr( $size ), esc_attr( $args['section'] ), esc_attr( $args['id'] ), $value_escaped, esc_attr( $args['std'] ), esc_attr( $args['placeholder'] ) );
$html_safe .= $this->get_field_description( $args );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Displays a separator field for a settings field
*
* @param array $args settings field args.
*/
public function callback_separator( $args ) {
echo '<div class="wpkit-separator"></div>';
}
/**
* Get the value of a settings field (or meta)
*
* @param string $option settings field name.
* @param string $section the section name this field belongs to.
* @param string $default default text if it's not found.
* @return string
*/
public function get_option( $option, $section, $default = '' ) {
if ( isset( $this->metabox ) ) {
global $post;
static $metas;
if ( null === $metas ) {
$metas = get_post_meta( $post->ID );
}
if ( isset( $metas[ $section . '_' . $option ] ) ) {
return $metas[ $section . '_' . $option ][0];
}
} else {
$options = get_option( $section );
if ( isset( $options[ $option ] ) ) {
return $options[ $option ];
}
}
return $default;
}
/**
* Add submenu page to the Settings main menu.
*
* @author Ahmad Awais
* @since [version]
*/
public function admin_menu() {
add_options_page(
'WP Settings Kit',
'WP Settings Kit',
'manage_options',
'wp_settings_kit',
array( $this, 'plugin_page' )
);
}
/**
* Plugin page callback
*/
public function plugin_page() {
echo '<div class="wrap">';
echo '<h1>WP Settings Kit <span style="font-size:50%;">v' . esc_attr( WP_SKIT_VERSION ) . '</span></h1>';
$this->show_navigation();
$this->show_forms();
echo '</div>';
}
/**
* Show navigations as tab
*
* Shows all the settings section labels as tab
*/
public function show_navigation() {
$html_safe = '<nav class="nav-tab-wrapper">';
foreach ( $this->sections_array as $tab ) {
$desc = isset( $tab['desc'] ) ? 'data-description="' . esc_attr( $tab['desc'] ) . '"' : '';
$html_safe .= sprintf( '<a href="#%1$s" class="nav-tab" id="%1$s-tab" %3$s>%2$s</a>', esc_attr( $tab['id'] ), esc_html( $tab['title'] ), $desc );
}
$html_safe .= '</nav>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped and safe html output
echo $html_safe;
}
/**
* Show the section settings forms
*
* This function displays every sections in a different form
*/
public function show_forms() {
?>
<div class="metabox-holder">