-
Notifications
You must be signed in to change notification settings - Fork 4
/
c2c-plugin.php
executable file
·1086 lines (977 loc) · 36.4 KB
/
c2c-plugin.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
/**
* @package C2C_Plugin
* @author Scott Reilly
* @version 061
*/
/*
Basis for other plugins.
Compatible with WordPress 4.9 through 5.7+.
*/
/*
Copyright (c) 2010-2021 by Scott Reilly (aka coffee2code)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
defined( 'ABSPATH' ) or die();
if ( ! class_exists( 'c2c_Plugin_061' ) ) :
abstract class c2c_Plugin_061 {
protected $plugin_css_version = '009';
protected $options = array();
protected $options_from_db = '';
protected $option_names = array();
protected $required_config = array( 'menu_name', 'name' );
protected $config_attributes = array(
'allow_html' => false,
'class' => array(),
'datatype' => '',
'default' => '',
'help' => '',
'input' => '',
'input_attributes' => '',
'label' => '',
'no_wrap' => false,
'numbered' => false,
'options' => '',
'output' => '', // likely deprecated
'required' => false
);
protected $saved_settings = false;
protected $saved_settings_msg = '';
private $setting_index = 0;
/**
* Returns the plugin framework's version.
*
* @since 040
*/
public function c2c_plugin_version() {
return '061';
}
/**
* Handles installation tasks, such as ensuring plugin options are instantiated and saved to options table.
*
* @param string $version Version of the plugin.
* @param string $id_base A unique base ID for the plugin (generally a lower-case, dash-separated version of plugin name).
* @param string $author_prefix Short (2-3 char) identifier for plugin author.
* @param string $file The __FILE__ value for the sub-class.
* @param array $plugin_options Optional. Array specifying further customization of plugin configuration.
*/
protected function __construct( $version, $id_base, $author_prefix, $file, $plugin_options = array() ) {
$id_base = sanitize_title( $id_base );
if ( ! file_exists( $file ) ) {
die( sprintf( $this->get_c2c_string( 'Invalid file specified for C2C_Plugin: %s' ), $file ) );
}
$u_id_base = str_replace( '-', '_', $id_base );
$author_prefix .= '_';
$defaults = array(
'admin_options_name' => $author_prefix . $u_id_base, // The setting under which all plugin settings are stored under (as array)
'config' => array(), // Default configuration
'disable_contextual_help' => false, // Prevent overriding of the contextual help?
'disable_update_check' => false, // Prevent WP from checking for updates to this plugin?
'hook_prefix' => $u_id_base . '_', // Prefix for all hooks
'form_name' => $u_id_base, // Name for the <form>
'menu_name' => '', // Specify this via plugin
'name' => '', // Full, localized version of the plugin name
'nonce_field' => 'update-' . $u_id_base, // Nonce field value
'settings_page' => 'options-general', // The type of the settings page.
'show_admin' => true, // Should admin be shown? Only applies if admin is enabled
'textdomain' => $id_base, // Textdomain for localization
'textdomain_subdir' => 'lang' // Subdirectory, relative to plugin's root, to hold localization files
);
$settings = wp_parse_args( $plugin_options, $defaults );
foreach ( array_keys( $defaults ) as $key ) {
$this->$key = $settings[ $key ];
}
$this->author_prefix = $author_prefix;
$this->id_base = $id_base;
$this->options_page = ''; // This will be set when the options is created
$this->plugin_basename = plugin_basename( $file );
$this->plugin_file = $file;
$this->plugin_path = plugins_url( '', $file );
$this->u_id_base = $u_id_base; // Underscored version of id_base
$this->version = $version;
$plugin_file = implode( '/', array_slice( explode( '/', $this->plugin_basename ), -2 ) );
add_action( 'init', array( $this, 'init' ) );
add_action( 'activate_' . $plugin_file, array( $this, 'install' ) );
add_action( 'deactivate_' . $plugin_file, array( $this, 'deactivate' ) );
if ( $this->is_plugin_admin_page() || $this->is_submitting_form() ) {
add_action( 'admin_init', array( $this, 'init_options' ) );
if ( ! $this->is_submitting_form() ) {
add_action( 'admin_head', array( $this, 'add_c2c_admin_css' ) );
}
}
}
/**
* A dummy magic method to prevent object from being cloned
*
* @since 036
*/
public function __clone() { _doing_it_wrong( __FUNCTION__, $this->get_c2c_string( 'Something went wrong.' ), '036' ); }
/**
* A dummy magic method to prevent object from being unserialized
*
* @since 036
*/
public function __wakeup() { _doing_it_wrong( __FUNCTION__, $this->get_c2c_string( 'Something went wrong.' ), '036' ); }
/**
* Returns the plugin's version.
*
* @since 031
*/
public function version() {
return $this->version;
}
/**
* Handles installation tasks.
*
* This can be overridden.
*/
public function install() {
}
/**
* Handles deactivation tasks
*
* This should be overridden.
*/
public function deactivate() { }
/**
* Handles actions to be hooked to 'init' action, such as loading text domain and loading plugin config data array.
*/
public function init() {
global $c2c_plugin_max_css_version;
if ( ! isset( $c2c_plugin_max_css_version ) || ( $c2c_plugin_max_css_version < $this->plugin_css_version ) ) {
$c2c_plugin_max_css_version = $this->plugin_css_version;
}
$this->load_textdomain();
$this->load_config();
$this->verify_config();
add_filter( 'plugin_row_meta', array( $this, 'donate_link' ), 10, 2 );
if ( $this->disable_update_check ) {
add_filter( 'http_request_args', array( $this, 'disable_update_check' ), 5, 2 );
}
if ( $this->show_admin && $this->settings_page && ! empty( $this->config ) && current_user_can( 'manage_options' ) ) {
add_action( 'admin_menu', array( $this, 'admin_menu' ) );
if ( ! $this->disable_contextual_help ) {
if ( version_compare( $GLOBALS['wp_version'], '3.3', '<' ) ) {
add_filter( 'contextual_help', array( $this, 'contextual_help' ), 10, 3 );
}
if ( $this->is_plugin_admin_page() ) {
add_thickbox();
}
}
}
$this->register_filters();
}
/**
* Determines if the running WordPress is relative to a given version.
*
* @since 052
*
* @param string $wp_ver A version string to compare the current WP
* version against.
* @param string $operator Optional. A comparison operator compatible with
* PHP's `version_compare()`. Default '>='.
* @return bool True if provided version is relative to the current version
* of WordPress according to comparison operation, else false.
*/
public function is_wp_version_cmp( $wp_ver, $operator = '>=' ) {
$operator = $operator ?: '>=';
return version_compare( $GLOBALS['wp_version'], $wp_ver, $operator );
}
/**
* Checks to see if the plugin has been upgraded from an earlier version.
*
* Calls handle_plugin_update() if an upgrade was detected. Override that
* to do whatever needs done to bring older settings, etc up-to-date.
*
* @since 021
*/
public function check_if_plugin_was_upgraded() {
// If there was no previous install of this plugin, then don't need to do anything here
if ( empty( $this->options_from_db ) ) {
return;
}
$_version = isset( $this->options['_version'] ) ? $this->options['_version'] : '0.0';
if ( $_version != $this->version ) {
// Save the original options into another option in case something goes wrong.
// TODO: Currently just saves one version back... should it save more?
update_option( 'bkup_' . $this->admin_options_name, $this->options );
$this->options['_version'] = $this->version;
$this->options = $this->handle_plugin_upgrade( $_version, $this->options );
update_option( $this->admin_options_name, $this->options );
}
}
/**
* Handle plugin updates. (To be implemented by inheriting class, if
* necessary.)
*
* Intended to be used for updating plugin options, etc.
*
* This is only called if the version stored in the db doesn't match the
* plugin's current version. At the very least the settings will get
* re-saved so that the new current version can be recorded.
*
* @since 021
*
* @param string $old_version The version number of the old version of
* the plugin. '0.0' indicates no version
* previously stored.
* @param array $options Array of all plugin options
*/
protected function handle_plugin_upgrade( $old_version, $options ) {
/* Example:
if ( version_compare( '1.2', $old_version ) > 0 ) {
// Plugin got upgraded from a version earlier than 1.2
// Which (for this example) is when a minimum value got raised
if ( $options['min_value'] < 5 )
$options['min_value'] = 5;
}
*/
return $options; // Important!
}
/**
* Prevents this plugin from being included when WordPress phones home
* to check for plugin updates.
*
* @param array $r Response array.
* @param string $url URL for the update check.
*
* @return array The response array with this plugin removed, if present.
*/
public function disable_update_check( $r, $url ) {
// Bail immediately if not a plugin update request.
$plugin_update_check_strpos = strpos( $url, '://api.wordpress.org/plugins/update-check' );
if ( 4 !== $plugin_update_check_strpos && 5 !== $plugin_update_check_strpos ) {
return $r;
}
$plugins = unserialize( $r['body']['plugins'] );
unset( $plugins->plugins[ $this->plugin_basename ] );
unset( $plugins->active[ array_search( $this->plugin_basename, $plugins->active ) ] );
$r['body']['plugins'] = serialize( $plugins );
return $r;
}
/**
* Initializes options.
*/
public function init_options() {
register_setting( $this->admin_options_name, $this->admin_options_name, array( $this, 'sanitize_inputs' ) );
add_settings_section( 'default', '', array( $this, 'options_page_description' ), $this->plugin_file );
add_filter(
$this->is_wp_version_cmp( '5.5' ) ? 'allowed_options' : 'whitelist_options',
array( $this, 'allowed_options' )
);
foreach ( $this->get_option_names( false ) as $opt ) {
add_settings_field( $opt, $this->get_option_label( $opt ), array( $this, 'display_option' ), $this->plugin_file, 'default', array( 'label_for' => $opt ) );
}
}
/**
* Allows the plugin's option(s)
*
* @since 052 Renamed from `whitelist_options()`.
*
* @param array $options Array of allowed options.
* @return array The amended allowed options array.
*/
public function allowed_options( $options ) {
$added = array( $this->admin_options_name => array( $this->admin_options_name ) );
return function_exists( 'add_allowed_options' )
? add_allowed_options( $added, $options )
: add_option_whitelist( $added, $options );
}
/**
* Outputs the descriptive text (and h2 heading) for the options page.
*
* Intended to be overridden by sub-class.
*
* @param string $localized_heading_text (optional) Localized page heading text.
*/
public function options_page_description( $localized_heading_text = '' ) {
if ( ! is_string( $localized_heading_text ) ) {
$localized_heading_text = '';
}
if ( empty( $localized_heading_text ) ) {
$localized_heading_text = $this->name;
}
if ( $localized_heading_text ) {
echo '<h1>' . $localized_heading_text . "</h1>\n";
}
if ( ! $this->disable_contextual_help ) {
echo '<p class="see-help">' . $this->get_c2c_string( 'See the "Help" link to the top-right of the page for more help.' ) . "</p>\n";
}
}
/**
* Gets the label for a given option.
*
* @param string $opt The option.
*
* @return string The label for the option.
*/
public function get_option_label( $opt ) {
$label = isset( $this->config[ $opt ]['label'] ) ? $this->config[ $opt ]['label'] : '';
if ( true === $this->config[ $opt ]['numbered'] ) {
$label = ++$this->setting_index . ". $label";
}
return $label;
}
/**
* Resets plugin options.
*
* @return array
*/
public function reset_options() {
$this->reset_caches();
// Delete the setting from the database.
delete_option( $this->admin_options_name );
$this->options = $this->get_options( false );
return $this->options;
}
/**
* Resets caches and data memoization.
*
* @since 044
*/
public function reset_caches() {
$this->options = array();
$this->option_names = array();
$this->options_from_db = '';
}
/**
* Sanitizes user inputs prior to saving.
*/
public function sanitize_inputs( $inputs ) {
do_action( $this->get_hook( 'before_save_options' ), $this );
if ( isset( $_POST['Reset'] ) ) {
$options = $this->reset_options();
add_settings_error( 'general', 'settings_reset', $this->get_c2c_string( 'Settings reset.' ), 'updated' );
unset( $_POST['Reset'] );
} else {
// Start with the existing options, then start overwriting their potential override value. (This prevents
// unscrupulous addition of fields by the user)
$options = $this->get_options();
$option_names = $this->get_option_names();
$option_names = (array) apply_filters( $this->get_hook( 'sanitized_option_names' ), $option_names, $inputs );
foreach ( $option_names as $opt ) {
if ( !isset( $inputs[ $opt ] ) ) {
if ( $this->config[ $opt ]['input'] == 'checkbox' ) {
$options[ $opt ] = '';
} elseif ( true === $this->config[ $opt ]['required'] ) {
$msg = sprintf( $this->get_c2c_string( 'A value is required for: "%s"' ), $this->config[ $opt ]['label'] );
add_settings_error( 'general', 'setting_required', $msg, 'error' );
}
}
else {
$val = $inputs[ $opt ];
$error = false;
if ( empty( $val ) && ( true === $this->config[ $opt ]['required'] ) ) {
$msg = sprintf( $this->get_c2c_string( 'A value is required for: "%s"' ), $this->config[ $opt ]['label'] );
$error = true;
} else {
$input = $this->config[ $opt ]['input'];
switch ( $this->config[ $opt ]['datatype'] ) {
case 'checkbox':
break;
case 'int':
if ( $val && is_string( $val ) ) {
$val = str_replace( ',', '', $val );
}
if ( ! empty( $val ) && ( ! is_numeric( $val ) || ( intval( $val ) != round( $val ) ) ) ) {
/* translators: %s: Label for setting. */
$msg = sprintf( $this->get_c2c_string( 'Expected integer value for: %s' ), $this->config[ $opt ]['label'] );
$error = true;
$val = '';
}
break;
case 'array':
if ( empty( $val ) )
$val = array();
elseif ( is_array( $val ) )
$val = array_map( 'trim', $val );
elseif ( $input == 'text' )
$val = explode( ',', str_replace( array( ', ', ' ', ',' ), ',', $val ) );
else
$val = array_map( 'trim', explode( "\n", trim( $val ) ) );
break;
case 'hash':
if ( 'select' !== $input && ! is_array( $val ) && '' !== $val ) {
$new_values = array();
foreach ( explode( "\n", $val ) AS $line ) {
// TODO: It's possible to allow multi-line replacement text, in which case
// instead of skipping invalid looking lines, simply append them to the
// previous line, joined with "\n".
if ( false === strpos( $line, '=>' ) ) {
continue;
}
list( $shortcut, $text ) = array_map( 'trim', explode( '=>', $line, 2 ) );
if ( $shortcut && '' !== $text ) {
$new_values[ str_replace( '\\', '', $shortcut ) ] = str_replace( '\\', '', $text );
}
}
$val = $new_values;
}
break;
}
}
if ( $error ) {
add_settings_error( 'general', 'setting_not_int', $msg, 'error' );
}
$options[ $opt ] = $val;
}
}
$options = apply_filters( $this->get_hook( 'before_update_option' ), $options, $this );
}
$options['_version'] = $this->version;
return $options;
}
/**
* Initializes the plugin's configuration and localizable text variables.
*/
abstract protected function load_config();
/**
* Returns translated strings used by c2c_Plugin parent class.
*
* @since 060
*
* @return string[]
*/
abstract public function get_c2c_string( $string );
/**
* Adds a new option to the plugin's configuration.
*
* Intended to be used for dynamically adding a new option after the config
* is initially created via load_config(), but it can be called earlier.
*
* @since 044
*
* @param string $option_name The option name.
* @param array $args The configuration for the setting.
* @return array The fully initialized option.
*/
public function add_option( $option_name, $args ) {
$this->config[ $option_name ] = $args;
// This function may be running after the config array has already been
// processed by the plugin, thus this new option won't be automatically
// verified, which includes setting defaults for setting attributes that
// weren't explicitly specified.
$this->verify_options( array( $option_name ) );
return $this->config[ $option_name ];
}
/**
* Verify that the necessary configuration files were set in the inheriting class.
*/
public function verify_config() {
// Ensure required configuration options have been configured via the sub-class. Die if any aren't.
foreach ( $this->required_config as $config ) {
if ( empty( $this->$config ) ) {
die( sprintf( $this->get_c2c_string( "The plugin configuration option '%s' must be supplied." ), $config ) );
}
}
// Set/change configuration options based on sub-class changes.
if ( empty( $this->config ) ) {
$this->show_admin = false;
} else {
$this->verify_options();
}
}
/**
* Initializes any option attributes that weren't specified by the plugin.
*
* @since 044
*
* @param array $options Array of all the option names to verify. Leave empty
* to verify them all. Default empty array.
*/
public function verify_options( $options = array() ) {
// If no options specified, assume them all.
if ( ! $options ) {
$options = $this->get_option_names( true );
}
foreach ( $options as $opt ) {
foreach ( $this->config_attributes as $attrib => $default) {
if ( ! isset( $this->config[ $opt ][ $attrib ] ) ) {
$this->config[ $opt ][ $attrib ] = $default;
}
}
if ( 'array' === $this->config[ $opt ]['datatype'] && ! is_array( $this->config[ $opt ]['default'] ) ) {
$this->config[ $opt ]['default'] = $this->config[ $opt ]['default'] ?
array( $this->config[ $opt ]['default'] ) :
array();
}
}
$this->reset_caches();
}
/**
* Loads the localization textdomain for the plugin.
*/
protected function load_textdomain() {
load_plugin_textdomain( $this->id_base );
}
/**
* Registers filters.
* NOTE: This occurs during the 'init' filter, so you can't use this to hook
* anything that happens earlier.
*/
public function register_filters() {
// This should be overridden in order to define filters.
}
/**
* Returns markup for simple contextual help text, comprising solely of a
* thickboxed link to the plugin's hosted readme.txt file.
*
* NOTE: If overriding this in a sub-class, be sure to include the check at
* the beginning of the function to ensure it shows up on its own settings
* admin page.
*
* @param string $contextual_help The default contextual help.
* @param int $screen_id The screen ID.
* @param object $screen The screen object (only supplied in WP 3.0).
* @return string
*/
public function contextual_help( $contextual_help, $screen_id, $screen = null ) {
if ( $screen_id != $this->options_page ) {
return $contextual_help;
}
$help = '<h3>' . $this->get_c2c_string( 'More Plugin Help' ) . '</h3>';
$help .= '<p class="more-help">';
$help .= sprintf(
'<a title="%s" class="thickbox" href="%s">%s</a>%s',
esc_attr( sprintf( $this->get_c2c_string( 'More information about %1$s %2$s' ), $this->name, $this->version ) ),
esc_url( admin_url( "plugin-install.php?tab=plugin-information&plugin={$this->id_base}&TB_iframe=true&width=640&height=514" ) ),
$this->get_c2c_string( 'Click for more help on this plugin' ),
$this->get_c2c_string( ' (especially check out the "Other Notes" tab, if present)' )
);
$help .= ".</p>\n";
return $help;
}
/**
* Outputs CSS into admin head of the plugin's settings page.
*/
public function add_c2c_admin_css() {
global $c2c_plugin_max_css_version, $c2c_plugin_css_was_output;
if ( ( $c2c_plugin_max_css_version != $this->plugin_css_version ) || ( isset( $c2c_plugin_css_was_output ) && $c2c_plugin_css_was_output ) ) {
return;
}
$c2c_plugin_css_was_output = true;
$logo = plugins_url( 'c2c_minilogo.png', $this->plugin_file );
/**
* Remember to increment the plugin_css_version variable if changing the CSS
*/
echo <<<HTML
<style type="text/css">
.long-text {width:98% !important;}
#c2c {
text-align:center;
color:#888;
background-color:#ffffef;
padding:5px 0 0;
margin-top:12px;
border-style:solid;
border-color:#dadada;
border-width:1px 0;
overflow: auto;
}
#c2c div:first-child {
margin:0 auto;
padding:5px 40px 0 0;
width:45%;
min-height:40px;
background:url('$logo') no-repeat top right;
}
#c2c span {
display:block;
font-size:x-small;
}
.form-table {margin-bottom:20px;}
.c2c-plugin-list {margin-left:2em;}
.c2c-plugin-list li {list-style:disc outside;}
.wrap {margin-bottom:30px !important;}
.c2c-form .hr, .c2c-hr {border-bottom:1px solid #ccc;padding:0 2px;margin-bottom:6px;}
.c2c-fieldset {border:1px solid #ccc; padding:2px 8px;}
.c2c-textarea, .c2c-inline_textarea {width:98%;font-family:"Courier New", Courier, mono; display: block;}
.see-help {font-size:x-small;font-style:italic;}
.more-help {display:block;margin-top:8px;}
</style>
HTML;
}
/**
* Registers the admin options page and the Settings link.
*/
public function admin_menu() {
add_filter( 'plugin_action_links_' . $this->plugin_basename, array( $this, 'plugin_action_links' ) );
switch ( $this->settings_page ) {
case 'options-general' :
$func_root = 'options';
break;
case 'themes' :
$func_root = 'theme';
break;
default :
$func_root = $this->settings_page;
}
$menu_func = 'add_' . $func_root . '_page';
if ( function_exists( $menu_func ) ) {
$this->options_page = call_user_func( $menu_func, $this->name, $this->menu_name, 'manage_options', $this->plugin_basename, array( $this, 'options_page' ) );
add_action( 'load-' . $this->options_page, array( $this, 'help_tabs' ) );
}
}
/**
* Initialize help tabs.
*
* @since 034
*/
public function help_tabs() {
if ( ! class_exists( 'WP_Screen' ) ) {
return;
}
$screen = get_current_screen();
if ( $screen->id != $this->options_page ) {
return;
}
$this->help_tabs_content( $screen );
}
/**
* Configures help tabs content.
*
* This should be overridden by inheriting class if it needs help content.
*
* @since 034
*/
public function help_tabs_content( $screen ) {
$screen->add_help_tab( array(
'id' => 'c2c-more-help-' . $this->id_base,
'title' => $this->get_c2c_string( 'More Help' ),
'content' => self::contextual_help( '', $this->options_page )
) );
}
/**
* Adds a 'Settings' link to the plugin action links.
*
* @param int $limit The default limit value for the current posts query.
*
* @return array Links associated with a plugin on the admin Plugins page
*/
public function plugin_action_links( $action_links ) {
$settings_link = '<a href="' . $this->settings_page . '.php?page='.$this->plugin_basename.'">' . $this->get_c2c_string( 'Settings' ) . '</a>';
array_unshift( $action_links, $settings_link );
return $action_links;
}
/**
* Adds donate link to plugin row.
*/
public function donate_link( $links, $file ) {
if ( $file == $this->plugin_basename ) {
$donation_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6ARCFJ9TX3522';
$donation_url .= urlencode( "Donation for coffee2code plugin: {$this->name}" );
$title = $this->get_c2c_string( 'Coffee fuels my coding.' );
$links[] = '<a href="' . esc_url( $donation_url ) . '" title="' . esc_attr( $title ) . '">' . $this->get_c2c_string( 'Donate' ) . '</a>';
}
return $links;
}
/**
* See if the setting is pertinent to this version of WP
*
* @since 013
*
* @param string $opt The option name.
*
* @return bool If the option is valid for this version of WP.
*/
protected function is_option_valid( $opt ) {
global $wp_version;
$valid = true;
$ver_operators = array( 'wpgt' => '>', 'wpgte' => '>=', 'wplt' => '<', 'wplte' => '<=' );
foreach ( $ver_operators as $ver_check => $ver_op ) {
if ( isset( $this->config[ $opt ][ $ver_check ] )
&& ! empty( $this->config[ $opt ][ $ver_check ] )
&& ! version_compare( $wp_version, $this->config[ $opt ][ $ver_check ], $ver_op ) ) {
$valid = false;
break;
}
}
return $valid;
}
/**
* Returns the list of option names.
*
* @param bool $include_non_options Optional. Should non-options be included? Default is false.
*
* @return array Array of option names.
*/
protected function get_option_names( $include_non_options = false ) {
$option_names = array();
if ( $include_non_options ) {
$option_names = array_keys( $this->config );
} else {
if ( ! $this->option_names ) {
$this->option_names = array();
foreach ( array_keys( $this->config ) as $opt ) {
if ( isset( $this->config[ $opt ]['input'] ) && $this->config[ $opt ]['input'] != '' && $this->config[ $opt ]['input'] != 'none' && $this->is_option_valid( $opt ) ) {
$this->option_names[] = $opt;
}
}
}
$option_names = $this->option_names;
}
return $option_names;
}
/**
* Returns either the buffered array of all options for the plugin, or
* obtains the options and buffers the value.
*
* @param bool $with_current_values Optional. Should the currently saved values be returned? If false, then the plugin's defaults are returned. Default is true.
*
* @return array The options array for the plugin (which is also stored in $this->options if !$with_options).
*/
public function get_options( $with_current_values = true ) {
if ( $with_current_values && $this->options ) {
return $this->options;
}
// Derive options from the config
$options = array();
$option_names = $this->get_option_names( ! $with_current_values );
foreach ( $option_names as $opt ) {
$options[ $opt ] = $this->config[ $opt ]['default'];
}
if ( ! $with_current_values ) {
return $options;
}
$this->options_from_db = get_option( $this->admin_options_name );
$this->options = wp_parse_args( $this->options_from_db, $options );
// Check to see if the plugin has been updated
$this->check_if_plugin_was_upgraded();
// Un-escape fields
foreach ( $option_names as $opt ) {
if ( $this->config[ $opt ]['allow_html'] == true ) {
if ( is_array( $this->options[ $opt ] ) ) {
foreach ( $this->options[ $opt ] as $key => $val ) {
$new_key = wp_specialchars_decode( $key, ENT_QUOTES );
$new_val = wp_specialchars_decode( $val, ENT_QUOTES );
$this->options[ $opt ][ $new_key ] = $new_val;
if ( $key != $new_key ) {
unset( $this->options[ $opt ][ $key ] );
}
}
} else {
$this->options[ $opt ] = wp_specialchars_decode( $this->options[ $opt ], ENT_QUOTES );
}
}
}
return apply_filters( $this->get_hook( 'options' ), $this->options );
}
/**
* Updates the options with values specifically defined.
*
* @since 037
*
* @param array $settings The new setting value(s)
* @param bool $with_reset Should the options be reset, with the new settings overlaid on top of the default settings?
*
* @return array
*/
public function update_option( $settings, $with_reset = false ) {
if ( $with_reset ) {
$this->reset_options();
}
$settings = $this->sanitize_inputs( $settings );
update_option( $this->admin_options_name, $settings );
return $this->options = $settings;
}
/**
* Gets the name to use for a form's <input type="hidden" name="XXX" value="1" />
*
* @param string $prefix A prefix string, unique to the form.
*
* @return string The name.
*/
protected function get_form_submit_name( $prefix ) {
return $prefix . '_' . $this->u_id_base;
}
/**
* Returns the URL for a plugin's form to use for its action attribute
*
* @return string The action URL
*/
protected function form_action_url() {
return $_SERVER['PHP_SELF'] . '?page=' . $this->plugin_basename;
}
/**
* Checks if the plugin's settings page has been submitted.
*
* @return bool True if the plugin's settings have been submitted for saving, else false.
*/
protected function is_submitting_form() {
return ( isset( $_POST['option_page'] ) && ( $_POST['option_page'] == $this->admin_options_name ) );
}
/**
* Checks if the current page is the plugin's settings page.
*
* @return bool True if on the plugin's settings page, else false.
*/
protected function is_plugin_admin_page() {
return ( basename( $_SERVER['PHP_SELF'], '.php' ) == $this->settings_page && isset( $_REQUEST['page'] ) && $_REQUEST['page'] == $this->plugin_basename );
}
/**
* Outputs the markup for an option's form field (and surrounding markup)
*
* @param string $opt The name/key of the option.
*/
public function display_option( $opt ) {
$opt = ! empty( $opt['label_for'] ) ? $opt['label_for'] : $opt;
do_action( $this->get_hook( 'pre_display_option' ), $opt );
$options = $this->get_options();
foreach ( array( 'datatype', 'input' ) as $attrib ) {
$$attrib = isset( $this->config[ $opt ][ $attrib ] ) ? $this->config[ $opt ][ $attrib ] : '';
}
if ( $input == '' || $input == 'none' ) {
return;
} elseif ( $input == 'custom' ) {
do_action( $this->get_hook( 'custom_display_option' ), $opt );
return;
}
$value = isset( $options[ $opt ] ) ? $options[ $opt ] : '';
$popt = $this->admin_options_name . "[{$opt}]";
if ( $input == 'multiselect' ) {
// Do nothing since it needs the values as an array
$popt .= '[]';
} elseif ( $datatype == 'array' ) {
if ( ! is_array( $value ) ) {
$value = '';
} else {
if ( $input == 'textarea' || $input == 'inline_textarea' ) {
$value = implode( "\n", $value );
} else {
$value = implode( ', ', $value );
}
}
} elseif ( $datatype == 'hash' && $input != 'select' ) {
if ( ! is_array( $value ) ) {
$value = '';
} else {
$new_value = '';
foreach ( $value AS $shortcut => $replacement ) {
$new_value .= "$shortcut => $replacement\n";
}
$value = $new_value;
}
} elseif ( $datatype === 'int' && is_numeric( $value ) ) {
$value = number_format_i18n( $value );
}
$attributes = $this->config[ $opt ]['input_attributes'];
$this->config[ $opt ]['class'][] = 'c2c-' . $input;
if ( ( 'textarea' == $input || 'inline_textarea' == $input ) && $this->config[ $opt ]['no_wrap'] ) {
$attributes .= ' wrap="off"'; // Does not validate, but only cross-browser technique
}
elseif ( in_array( $input, array( 'text', 'long_text', 'short_text' ) ) ) {
$this->config[ $opt ]['class'][] = ( ( $input == 'short_text' ) ? 'small-text' : 'regular-text' );
if ( $input == 'long_text' ) {
$this->config[ $opt ]['class'][] = ' long-text';
}
$input = 'text';
}
$class = implode( ' ', $this->config[ $opt ]['class'] );
$attribs = "name='{$popt}' id='{$opt}' class='{$class}' {$attributes}";
if ( $input == '' ) {
// Change of implementation prevents this from being possible (since this function only gets called for registered settings)
// if ( !empty( $this->config[ $opt ]['output'] ) )
// echo $this->config[ $opt ]['output'] . "\n";
// else
// echo '<div class="hr"> </div>' . "\n";
} elseif ( $input == 'textarea' || $input == 'inline_textarea' ) {
if ( $input == 'textarea' ) {
echo "</td><tr><td colspan='2'>";
}
echo "<textarea {$attribs}>{$value}</textarea>\n";
} elseif ( $input == 'select' ) {
echo "<select $attribs>";
if ( $this->config[ $opt ]['datatype'] == 'hash' ) {
foreach ( (array) $this->config[ $opt ]['options'] as $sopt => $sval ) {
echo "<option value='{$sopt}' " . selected( $value, $sopt, false ) . ">{$sval}</option>\n";
}
} else {
foreach ( (array) $this->config[ $opt ]['options'] as $sopt ) {
echo "<option value='{$sopt}' " . selected( $value, $sopt, false ) . ">{$sopt}</option>\n";
}
}
echo "</select>";
} elseif ( $input == 'multiselect' ) {
echo '<fieldset class="c2c-fieldset">' . "\n";