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
|
<?php /** * WPSEO plugin file. * * @package WPSEO\Admin */
/** * Admin form class. * * @since 2.0 */ class Yoast_Form {
/** * Instance of this class * * @var object * @since 2.0 */ public static $instance;
/** * @var string * @since 2.0 */ public $option_name;
/** * @var array * @since 2.0 */ public $options = array();
/** * Option instance. * * @since 8.4 * @var WPSEO_Option|null */ protected $option_instance = null;
/** * Get the singleton instance of this class. * * @since 2.0 * * @return Yoast_Form */ public static function get_instance() { if ( ! ( self::$instance instanceof self ) ) { self::$instance = new self(); }
return self::$instance; }
/** * Generates the header for admin pages. * * @since 2.0 * * @param bool $form Whether or not the form start tag should be included. * @param string $option The short name of the option to use for the current page. * @param bool $contains_files Whether the form should allow for file uploads. * @param bool $option_long_name Group name of the option. */ public function admin_header( $form = true, $option = 'wpseo', $contains_files = false, $option_long_name = false ) { if ( ! $option_long_name ) { $option_long_name = WPSEO_Options::get_group_name( $option ); } ?> <div class="wrap yoast wpseo-admin-page <?php echo esc_attr( 'page-' . $option ); ?>"> <?php /** * Display the updated/error messages. * Only needed as our settings page is not under options, otherwise it will automatically be included. * * @see settings_errors() */ require_once ABSPATH . 'wp-admin/options-head.php'; ?> <h1 id="wpseo-title"><?php echo esc_html( get_admin_page_title() ); ?></h1> <div class="wpseo_content_wrapper"> <div class="wpseo_content_cell" id="wpseo_content_top"> <?php if ( $form === true ) { $enctype = ( $contains_files ) ? ' enctype="multipart/form-data"' : '';
$network_admin = new Yoast_Network_Admin(); if ( $network_admin->meets_requirements() ) { $action_url = network_admin_url( 'settings.php' ); $hidden_fields_cb = array( $network_admin, 'settings_fields' ); } else { $action_url = admin_url( 'options.php' ); $hidden_fields_cb = 'settings_fields'; }
echo '<form action="' . esc_url( $action_url ) . '" method="post" id="wpseo-conf"' . $enctype . ' accept-charset="' . esc_attr( get_bloginfo( 'charset' ) ) . '">'; call_user_func( $hidden_fields_cb, $option_long_name ); } $this->set_option( $option ); }
/** * Set the option used in output for form elements. * * @since 2.0 * * @param string $option_name Option key. */ public function set_option( $option_name ) { $this->option_name = $option_name;
$this->options = WPSEO_Options::get_option( $option_name ); if ( $this->options === null ) { $this->options = (array) get_option( $option_name, array() ); }
$this->option_instance = WPSEO_Options::get_option_instance( $option_name ); if ( ! $this->option_instance ) { $this->option_instance = null; } }
/** * Sets a value in the options. * * @since 5.4 * * @param string $key The key of the option to set. * @param mixed $value The value to set the option to. * @param bool $overwrite Whether to overwrite existing options. Default is false. */ public function set_options_value( $key, $value, $overwrite = false ) { if ( $overwrite || ! array_key_exists( $key, $this->options ) ) { $this->options[ $key ] = $value; } }
/** * Generates the footer for admin pages. * * @since 2.0 * * @param bool $submit Whether or not a submit button and form end tag should be shown. * @param bool $show_sidebar Whether or not to show the banner sidebar - used by premium plugins to disable it. */ public function admin_footer( $submit = true, $show_sidebar = true ) { if ( $submit ) { submit_button( __( 'Save changes', 'wordpress-seo' ) );
echo ' </form>'; }
/** * Apply general admin_footer hooks. */ do_action( 'wpseo_admin_footer', $this );
/** * Run possibly set actions to add for example an i18n box. */ do_action( 'wpseo_admin_promo_footer' );
echo ' </div><!-- end of div wpseo_content_top -->';
if ( $show_sidebar ) { $this->admin_sidebar(); }
echo '</div><!-- end of div wpseo_content_wrapper -->';
do_action( 'wpseo_admin_below_content', $this );
echo ' </div><!-- end of wrap -->'; }
/** * Generates the sidebar for admin pages. * * @since 2.0 */ public function admin_sidebar() { // No banners in Premium. $addon_manager = new WPSEO_Addon_Manager(); if ( WPSEO_Utils::is_yoast_seo_premium() && $addon_manager->has_valid_subscription( WPSEO_Addon_Manager::PREMIUM_SLUG ) ) { return; }
require_once 'views/sidebar.php'; }
/** * Output a label element. * * @since 2.0 * * @param string $text Label text string. * @param array $attr HTML attributes set. */ public function label( $text, $attr ) { $defaults = array( 'class' => 'checkbox', 'close' => true, 'for' => '', 'aria_label' => '', );
$attr = wp_parse_args( $attr, $defaults ); $aria_label = ''; if ( $attr['aria_label'] !== '' ) { $aria_label = ' aria-label="' . esc_attr( $attr['aria_label'] ) . '"'; }
echo "<label class='" . esc_attr( $attr['class'] ) . "' for='" . esc_attr( $attr['for'] ) . "'$aria_label>$text"; if ( $attr['close'] ) { echo '</label>'; } }
/** * Output a legend element. * * @since 3.4 * * @param string $text Legend text string. * @param array $attr HTML attributes set. */ public function legend( $text, $attr ) { $defaults = array( 'id' => '', 'class' => '', ); $attr = wp_parse_args( $attr, $defaults );
$id = ( '' === $attr['id'] ) ? '' : ' id="' . esc_attr( $attr['id'] ) . '"'; echo '<legend class="yoast-form-legend ' . esc_attr( $attr['class'] ) . '"' . $id . '>' . $text . '</legend>'; }
/** * Create a Checkbox input field. * * @since 2.0 * * @param string $var The variable within the option to create the checkbox for. * @param string $label The label to show for the variable. * @param bool $label_left Whether the label should be left (true) or right (false). */ public function checkbox( $var, $label, $label_left = false ) { if ( ! isset( $this->options[ $var ] ) ) { $this->options[ $var ] = false; }
if ( $this->options[ $var ] === true ) { $this->options[ $var ] = 'on'; }
$class = ''; if ( $label_left !== false ) { if ( ! empty( $label_left ) ) { $label_left .= ':'; } $this->label( $label_left, array( 'for' => $var ) ); } else { $class = 'double'; }
echo '<input class="checkbox ', esc_attr( $class ), '" type="checkbox" id="', esc_attr( $var ), '" name="', esc_attr( $this->option_name ), '[', esc_attr( $var ), ']" value="on"', checked( $this->options[ $var ], 'on', false ), disabled( $this->is_control_disabled( $var ), true, false ), '/>';
if ( ! empty( $label ) ) { $this->label( $label, array( 'for' => $var ) ); }
echo '<br class="clear" />'; }
/** * Create a light switch input field using a single checkbox. * * @since 3.1 * * @param string $var The variable within the option to create the checkbox for. * @param string $label The label element text for the checkbox. * @param array $buttons Array of two visual labels for the buttons (defaults Disabled/Enabled). * @param bool $reverse Reverse order of buttons (default true). * @param string $help Inline Help that will be printed out before the visible toggles text. */ public function light_switch( $var, $label, $buttons = array(), $reverse = true, $help = '' ) {
if ( ! isset( $this->options[ $var ] ) ) { $this->options[ $var ] = false; }
if ( $this->options[ $var ] === true ) { $this->options[ $var ] = 'on'; }
$class = 'switch-light switch-candy switch-yoast-seo';
if ( $reverse ) { $class .= ' switch-yoast-seo-reverse'; }
if ( empty( $buttons ) ) { $buttons = array( __( 'Disabled', 'wordpress-seo' ), __( 'Enabled', 'wordpress-seo' ) ); }
list( $off_button, $on_button ) = $buttons;
$help_class = ''; $screen_reader_text_class = '';
$help_class = ! empty( $help ) ? ' switch-container__has-help' : '';
echo '<div class="switch-container', $help_class, '">', '<span class="switch-light-visual-label" id="', esc_attr( $var . '-label' ), '">', esc_html( $label ), '</span>' . $help, '<label class="', $class, '"><b class="switch-yoast-seo-jaws-a11y"> </b>', '<input type="checkbox" aria-labelledby="', esc_attr( $var . '-label' ), '" id="', esc_attr( $var ), '" name="', esc_attr( $this->option_name ), '[', esc_attr( $var ), ']" value="on"', checked( $this->options[ $var ], 'on', false ), disabled( $this->is_control_disabled( $var ), true, false ), '/>', '<span aria-hidden="true"> <span>', esc_html( $off_button ) ,'</span> <span>', esc_html( $on_button ) ,'</span> <a></a> </span> </label><div class="clear"></div></div>'; }
/** * Create a Text input field. * * @since 2.0 * @since 2.1 Introduced the `$attr` parameter. * * @param string $var The variable within the option to create the text input field for. * @param string $label The label to show for the variable. * @param array|string $attr Extra attributes to add to the input field. Can be class, disabled, autocomplete. */ public function textinput( $var, $label, $attr = array() ) { if ( ! is_array( $attr ) ) { $attr = array( 'class' => $attr, 'disabled' => false, ); }
$defaults = array( 'placeholder' => '', 'class' => '', ); $attr = wp_parse_args( $attr, $defaults ); $val = isset( $this->options[ $var ] ) ? $this->options[ $var ] : ''; $attributes = isset( $attr['autocomplete'] ) ? ' autocomplete="' . esc_attr( $attr['autocomplete'] ) . '"' : ''; if ( isset( $attr['disabled'] ) && $attr['disabled'] ) { $attributes .= ' disabled'; }
$this->label( $label . ':', array( 'for' => $var, 'class' => 'textinput', ) ); echo '<input' . $attributes . ' class="textinput ' . esc_attr( $attr['class'] ) . ' " placeholder="' . esc_attr( $attr['placeholder'] ) . '" type="text" id="', esc_attr( $var ), '" name="', esc_attr( $this->option_name ), '[', esc_attr( $var ), ']" value="', esc_attr( $val ), '"', disabled( $this->is_control_disabled( $var ), true, false ), '/>', '<br class="clear" />'; }
/** * Create a textarea. * * @since 2.0 * * @param string $var The variable within the option to create the textarea for. * @param string $label The label to show for the variable. * @param string|array $attr The CSS class or an array of attributes to assign to the textarea. */ public function textarea( $var, $label, $attr = array() ) { if ( ! is_array( $attr ) ) { $attr = array( 'class' => $attr, ); }
$defaults = array( 'cols' => '', 'rows' => '', 'class' => '', ); $attr = wp_parse_args( $attr, $defaults ); $val = ( isset( $this->options[ $var ] ) ) ? $this->options[ $var ] : '';
$this->label( $label . ':', array( 'for' => $var, 'class' => 'textinput', ) ); echo '<textarea cols="' . esc_attr( $attr['cols'] ) . '" rows="' . esc_attr( $attr['rows'] ) . '" class="textinput ' . esc_attr( $attr['class'] ) . '" id="' . esc_attr( $var ) . '" name="' . esc_attr( $this->option_name ) . '[' . esc_attr( $var ) . ']"', disabled( $this->is_control_disabled( $var ), true, false ), '>' . esc_textarea( $val ) . '</textarea><br class="clear" />'; }
/** * Create a hidden input field. * * @since 2.0 * * @param string $var The variable within the option to create the hidden input for. * @param string $id The ID of the element. */ public function hidden( $var, $id = '' ) { $val = ( isset( $this->options[ $var ] ) ) ? $this->options[ $var ] : ''; if ( is_bool( $val ) ) { $val = ( $val === true ) ? 'true' : 'false'; }
if ( '' === $id ) { $id = 'hidden_' . $var; }
echo '<input type="hidden" id="' . esc_attr( $id ) . '" name="' . esc_attr( $this->option_name ) . '[' . esc_attr( $var ) . ']" value="' . esc_attr( $val ) . '"/>'; }
/** * Create a Select Box. * * @since 2.0 * * @param string $var The variable within the option to create the select for. * @param string $label The label to show for the variable. * @param array $select_options The select options to choose from. * @param string $styled The select style. Use 'styled' to get a styled select. Default 'unstyled'. * @param bool $show_label Whether or not to show the label, if not, it will be applied as an aria-label. */ public function select( $var, $label, array $select_options, $styled = 'unstyled', $show_label = true ) {
if ( empty( $select_options ) ) { return; }
if ( $show_label ) { $this->label( $label . ':', array( 'for' => $var, 'class' => 'select',
) ); }
$select_name = esc_attr( $this->option_name ) . '[' . esc_attr( $var ) . ']'; $active_option = ( isset( $this->options[ $var ] ) ) ? $this->options[ $var ] : ''; $wrapper_start_tag = ''; $wrapper_end_tag = '';
$select = new Yoast_Input_Select( $var, $select_name, $select_options, $active_option ); $select->add_attribute( 'class', 'select' ); if ( $this->is_control_disabled( $var ) ) { $select->add_attribute( 'disabled', 'disabled' ); } if ( ! $show_label ) { $select->add_attribute( 'aria-label', $label ); }
if ( $styled === 'styled' ) { $wrapper_start_tag = '<span class="yoast-styled-select">'; $wrapper_end_tag = '</span>'; }
echo $wrapper_start_tag; $select->output_html(); echo $wrapper_end_tag; echo '<br class="clear"/>'; }
/** * Create a File upload field. * * @since 2.0 * * @param string $var The variable within the option to create the file upload field for. * @param string $label The label to show for the variable. */ public function file_upload( $var, $label ) { $val = ''; if ( isset( $this->options[ $var ] ) && is_array( $this->options[ $var ] ) ) { $val = $this->options[ $var ]['url']; }
$var_esc = esc_attr( $var ); $this->label( $label . ':', array( 'for' => $var, 'class' => 'select', ) ); echo '<input type="file" value="' . esc_attr( $val ) . '" class="textinput" name="' . esc_attr( $this->option_name ) . '[' . $var_esc . ']" id="' . $var_esc . '"', disabled( $this->is_control_disabled( $var ), true, false ), '/>';
// Need to save separate array items in hidden inputs, because empty file inputs type will be deleted by settings API. if ( ! empty( $this->options[ $var ] ) ) { $this->hidden( 'file', $this->option_name . '_file' ); $this->hidden( 'url', $this->option_name . '_url' ); $this->hidden( 'type', $this->option_name . '_type' ); } echo '<br class="clear"/>'; }
/** * Media input. * * @since 2.0 * * @param string $var Option name. * @param string $label Label message. */ public function media_input( $var, $label ) { $val = ''; if ( isset( $this->options[ $var ] ) ) { $val = $this->options[ $var ]; }
$id_value = ''; if ( isset( $this->options[ $var . '_id' ] ) ) { $id_value = $this->options[ $var . '_id' ]; }
$var_esc = esc_attr( $var );
$this->label( $label . ':', array( 'for' => 'wpseo_' . $var, 'class' => 'select', ) );
$id_field_id = 'wpseo_' . $var_esc . '_id';
echo '<span>'; echo '<input', ' class="textinput"', ' id="wpseo_', $var_esc, '"', ' type="text" size="36"', ' name="', esc_attr( $this->option_name ), '[', $var_esc, ']"', ' value="', esc_attr( $val ), '"', ' readonly="readonly"', ' /> '; echo '<input', ' id="wpseo_', $var_esc, '_button"', ' class="wpseo_image_upload_button button"', ' type="button"', ' value="', esc_attr__( 'Upload Image', 'wordpress-seo' ), '"', ' data-target-id="', esc_attr( $id_field_id ), '"', disabled( $this->is_control_disabled( $var ), true, false ), ' /> '; echo '<input', ' class="wpseo_image_remove_button button"', ' type="button"', ' value="', esc_attr__( 'Clear Image', 'wordpress-seo' ), '"', disabled( $this->is_control_disabled( $var ), true, false ), ' />'; echo '<input', ' type="hidden"', ' id="', esc_attr( $id_field_id ), '"', ' name="', esc_attr( $this->option_name ), '[', $var_esc, '_id]"', ' value="', esc_attr( $id_value ), '"', ' />'; echo '</span>'; echo '<br class="clear"/>'; }
/** * Create a Radio input field. * * @since 2.0 * * @param string $var The variable within the option to create the radio button for. * @param array $values The radio options to choose from. * @param string $legend Optional. The legend to show for the field set, if any. * @param array $legend_attr Optional. The attributes for the legend, if any. */ public function radio( $var, $values, $legend = '', $legend_attr = array() ) { if ( ! is_array( $values ) || $values === array() ) { return; } if ( ! isset( $this->options[ $var ] ) ) { $this->options[ $var ] = false; }
$var_esc = esc_attr( $var );
echo '<fieldset class="yoast-form-fieldset wpseo_radio_block" id="' . $var_esc . '">';
if ( is_string( $legend ) && '' !== $legend ) {
$defaults = array( 'id' => '', 'class' => 'radiogroup', );
$legend_attr = wp_parse_args( $legend_attr, $defaults );
$this->legend( $legend, $legend_attr ); }
foreach ( $values as $key => $value ) { $label = $value; $aria_label = '';
if ( is_array( $value ) ) { $label = isset( $value['label'] ) ? $value['label'] : ''; $aria_label = isset( $value['aria_label'] ) ? $value['aria_label'] : ''; }
$key_esc = esc_attr( $key ); echo '<input type="radio" class="radio" id="' . $var_esc . '-' . $key_esc . '" name="' . esc_attr( $this->option_name ) . '[' . $var_esc . ']" value="' . $key_esc . '" ' . checked( $this->options[ $var ], $key_esc, false ) . disabled( $this->is_control_disabled( $var ), true, false ) . ' />'; $this->label( $label, array( 'for' => $var_esc . '-' . $key_esc, 'class' => 'radio', 'aria_label' => $aria_label, ) ); } echo '</fieldset>'; }
/** * Create a toggle switch input field using two radio buttons. * * @since 3.1 * * @param string $var The variable within the option to create the radio buttons for. * @param array $values Associative array of on/off keys and their values to be used as * the label elements text for the radio buttons. Optionally, each * value can be an array of visible label text and screen reader text. * @param string $label The visual label for the radio buttons group, used as the fieldset legend. * @param string $help Inline Help that will be printed out before the visible toggles text. */ public function toggle_switch( $var, $values, $label, $help = '' ) { if ( ! is_array( $values ) || $values === array() ) { return; } if ( ! isset( $this->options[ $var ] ) ) { $this->options[ $var ] = false; } if ( $this->options[ $var ] === true ) { $this->options[ $var ] = 'on'; } if ( $this->options[ $var ] === false ) { $this->options[ $var ] = 'off'; }
$help_class = ! empty( $help ) ? ' switch-container__has-help' : '';
$var_esc = esc_attr( $var );
printf( '<div class="%s">', esc_attr( 'switch-container' . $help_class ) ); echo '<fieldset id="', $var_esc, '" class="fieldset-switch-toggle"><legend>', $label, '</legend>', $help;
echo $this->get_disabled_note( $var ); echo '<div class="switch-toggle switch-candy switch-yoast-seo">';
foreach ( $values as $key => $value ) { $screen_reader_text_html = '';
if ( is_array( $value ) ) { $screen_reader_text = $value['screen_reader_text']; $screen_reader_text_html = '<span class="screen-reader-text"> ' . esc_html( $screen_reader_text ) . '</span>'; $value = $value['text']; }
$key_esc = esc_attr( $key ); $for = $var_esc . '-' . $key_esc; echo '<input type="radio" id="' . $for . '" name="' . esc_attr( $this->option_name ) . '[' . $var_esc . ']" value="' . $key_esc . '" ' . checked( $this->options[ $var ], $key_esc, false ) . disabled( $this->is_control_disabled( $var ), true, false ) . ' />', '<label for="', $for, '">', esc_html( $value ), $screen_reader_text_html,'</label>'; }
echo '<a></a></div></fieldset><div class="clear"></div></div>' . PHP_EOL . PHP_EOL; }
/** * Creates a toggle switch to define whether an indexable should be indexed or not. * * @param string $var The variable within the option to create the radio buttons for. * @param string $label The visual label for the radio buttons group, used as the fieldset legend. * @param string $help Inline Help that will be printed out before the visible toggles text. * * @return void */ public function index_switch( $var, $label, $help = '' ) { $index_switch_values = array( 'off' => __( 'Yes', 'wordpress-seo' ), 'on' => __( 'No', 'wordpress-seo' ), );
$this->toggle_switch( $var, $index_switch_values, sprintf( /* translators: %s expands to an indexable object's name, like a post type or taxonomy */ esc_html__( 'Show %s in search results?', 'wordpress-seo' ), '<strong>' . esc_html( $label ) . '</strong>' ), $help ); }
/** * Creates a toggle switch to show hide certain options. * * @param string $var The variable within the option to create the radio buttons for. * @param string $label The visual label for the radio buttons group, used as the fieldset legend. * @param bool $inverse_keys Whether or not the option keys need to be inverted to support older functions. * @param string $help Inline Help that will be printed out before the visible toggles text. * * @return void */ public function show_hide_switch( $var, $label, $inverse_keys = false, $help = '' ) { $on_key = ( $inverse_keys ) ? 'off' : 'on'; $off_key = ( $inverse_keys ) ? 'on' : 'off';
$show_hide_switch = array( $on_key => __( 'Show', 'wordpress-seo' ), $off_key => __( 'Hide', 'wordpress-seo' ), );
$this->toggle_switch( $var, $show_hide_switch, $label, $help ); }
/** * Checks whether a given control should be disabled. * * @param string $var The variable within the option to check whether its control should be disabled. * * @return bool True if control should be disabled, false otherwise. */ protected function is_control_disabled( $var ) { if ( $this->option_instance === null ) { return false; }
return $this->option_instance->is_disabled( $var ); }
/** * Gets the explanation note to print if a given control is disabled. * * @param string $var The variable within the option to print a disabled note for. * * @return string Explanation note HTML string, or empty string if no note necessary. */ protected function get_disabled_note( $var ) { if ( ! $this->is_control_disabled( $var ) ) { return ''; }
return '<p class="disabled-note">' . esc_html__( 'This feature has been disabled by the network admin.', 'wordpress-seo' ) . '</p>'; }
/* ********************* DEPRECATED METHODS ********************* */
/** * Retrieve options based on whether we're on multisite or not. * * @since 1.2.4 * @since 2.0 Moved to this class. * @deprecated 8.4 * @codeCoverageIgnore * * @return array The option's value. */ public function get_option() { _deprecated_function( __METHOD__, 'WPSEO 8.4' );
if ( is_network_admin() ) { return get_site_option( $this->option_name ); }
return get_option( $this->option_name ); } }
|