class-yoast-form.php
14.6 KB
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
<?php
/**
* @package WPSEO\Admin
*/
/**
* Admin form class.
*/
class Yoast_Form {
/**
* @var object Instance of this class
*/
public static $instance;
/**
* @var string
*/
public $option_name;
/**
* @var array
*/
public $options;
/**
* Get the singleton instance of this class
*
* @return object
*/
public static function get_instance() {
if ( ! ( self::$instance instanceof self ) ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Generates the header for admin pages
*
* @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
*/
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 wpseo-admin-page page-<?php echo $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' );
?>
<h2 id="wpseo-title"><?php echo esc_html( get_admin_page_title() ); ?></h2>
<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"' : '';
echo '<form action="' . esc_url( admin_url( 'options.php' ) ) . '" method="post" id="wpseo-conf"' . $enctype . ' accept-charset="' . esc_attr( get_bloginfo( 'charset' ) ) . '">';
settings_fields( $option_long_name );
}
$this->set_option( $option );
}
/**
* Set the option used in output for form elements
*
* @param string $option_name
*/
public function set_option( $option_name ) {
$this->option_name = $option_name;
$this->options = $this->get_option();
}
/**
* Retrieve options based on whether we're on multisite or not.
*
* @since 1.2.4
*
* @return array
*/
private function get_option() {
if ( is_network_admin() ) {
return get_site_option( $this->option_name );
}
return get_option( $this->option_name );
}
/**
* Generates the footer for admin pages
*
* @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();
echo '
</form>';
}
do_action( 'wpseo_admin_footer' );
echo '
</div><!-- end of div wpseo_content_top -->';
if ( $show_sidebar ) {
$this->admin_sidebar();
}
echo '</div><!-- end of div wpseo_content_wrapper -->';
if ( ( defined( 'WP_DEBUG' ) && WP_DEBUG === true ) ) {
$xdebug = ( extension_loaded( 'xdebug' ) ? true : false );
echo '
<div id="poststuff">
<div id="wpseo-debug-info" class="postbox">
<h3 class="hndle"><span>' . __( 'Debug Information', 'wordpress-seo' ) . '</span></h3>
<div class="inside">
<h4>' . esc_html( __( 'Current option:', 'wordpress-seo' ) ) . ' <span class="wpseo-debug">' . esc_html( $this->option_name ) . '</span></h4>
' . ( ( $xdebug ) ? '' : '<pre>' );
var_dump( $this->get_option() );
echo '
' . ( ( $xdebug ) ? '' : '</pre>' ) . '
</div>
</div>
</div>';
}
echo '
</div><!-- end of wrap -->';
}
/**
* Generates the sidebar for admin pages.
*/
public function admin_sidebar() {
// No banners in Premium.
if ( class_exists( 'WPSEO_Product_Premium' ) ) {
$license_manager = new Yoast_Plugin_License_Manager( new WPSEO_Product_Premium() );
if ( $license_manager->license_is_valid() ) {
return;
}
}
$service_banners = array(
array(
'url' => 'https://yoast.com/hire-us/website-review/#utm_source=wordpress-seo-config&utm_medium=banner&utm_campaign=website-review-banner',
'img' => 'banner-website-review.png',
'alt' => 'Website Review banner',
),
);
$plugin_banners = array(
array(
'url' => 'https://yoast.com/wordpress/plugins/seo-premium/#utm_source=wordpress-seo-config&utm_medium=banner&utm_campaign=premium-seo-banner',
'img' => 'banner-premium-seo.png',
'alt' => 'Banner Yoast SEO Premium',
),
);
if ( ! class_exists( 'wpseo_Video_Sitemap' ) ) {
$plugin_banners[] = array(
'url' => 'https://yoast.com/wordpress/plugins/video-seo/#utm_source=wordpress-seo-config&utm_medium=banner&utm_campaign=video-seo-banner',
'img' => 'banner-video-seo.png',
'alt' => 'Banner Yoast Video SEO plugin',
);
}
if ( class_exists( 'Woocommerce' ) && ! class_exists( 'Yoast_WooCommerce_SEO' ) ) {
$plugin_banners[] = array(
'url' => 'https://yoast.com/wordpress/plugins/yoast-woocommerce-seo/#utm_source=wordpress-seo-config&utm_medium=banner&utm_campaign=woocommerce-seo-banner',
'img' => 'banner-woocommerce-seo.png',
'alt' => 'Banner Yoast WooCommerce SEO plugin',
);
}
if ( ! defined( 'WPSEO_LOCAL_VERSION' ) ) {
$plugin_banners[] = array(
'url' => 'https://yoast.com/wordpress/plugins/local-seo/#utm_source=wordpress-seo-config&utm_medium=banner&utm_campaign=local-seo-banner',
'img' => 'banner-local-seo.png',
'alt' => 'Banner Yoast Local SEO plugin',
);
}
if ( ! class_exists( 'WPSEO_News' ) ) {
$plugin_banners[] = array(
'url' => 'https://yoast.com/wordpress/plugins/news-seo/#utm_source=wordpress-seo-config&utm_medium=banner&utm_campaign=news-seo-banner',
'img' => 'banner-news-seo.png',
'alt' => 'Banner Yoast News SEO plugin',
);
}
shuffle( $service_banners );
shuffle( $plugin_banners );
?>
<div class="wpseo_content_cell" id="sidebar-container">
<div id="sidebar">
<?php
$service_banner = $service_banners[0];
echo '<a target="_blank" href="' . esc_url( $service_banner['url'] ) . '"><img width="261" height="190" src="' . plugins_url( 'images/' . $service_banner['img'], WPSEO_FILE ) . '" alt="' . esc_attr( $service_banner['alt'] ) . '"/></a><br/><br/>';
$i = 0;
foreach ( $plugin_banners as $banner ) {
if ( $i == 2 ) {
break;
}
echo '<a target="_blank" href="' . esc_url( $banner['url'] ) . '"><img width="261" height="130" src="' . plugins_url( 'images/' . $banner['img'], WPSEO_FILE ) . '" alt="' . esc_attr( $banner['alt'] ) . '"/></a><br/><br/>';
$i ++;
}
?>
<strong><?php _e( 'Remove these ads?', 'wordpress-seo' ); ?></strong><br/>
<a target="_blank" href="https://yoast.com/wordpress/plugins/seo-premium/#utm_source=wordpress-seo-config&utm_medium=textlink&utm_campaign=remove-ads-link"><?php
/* translators: %1$s expands to Yoast SEO Premium */
printf( __( 'Upgrade to %1$s »', 'wordpress-seo' ), 'Yoast SEO Premium' ); ?></a><br/><br/>
</div>
</div>
<?php
}
/**
* Output a label element
*
* @param string $text
* @param array $attr
*/
public function label( $text, $attr ) {
$attr = wp_parse_args( $attr, array(
'class' => 'checkbox',
'close' => true,
'for' => '',
)
);
echo "<label class='" . $attr['class'] . "' for='" . esc_attr( $attr['for'] ) . "'>$text";
if ( $attr['close'] ) {
echo '</label>';
}
}
/**
* Create a Checkbox input field.
*
* @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 ), '/>';
if ( ! empty( $label ) ) {
$this->label( $label, array( 'for' => $var ) );
}
echo '<br class="clear" />';
}
/**
* Create a Text input field.
*
* @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 class to add to the input field.
*/
public function textinput( $var, $label, $attr = array() ) {
if ( ! is_array( $attr ) ) {
$attr = array(
'class' => $attr,
);
}
$attr = wp_parse_args( $attr, array(
'placeholder' => '',
'class' => '',
) );
$val = ( isset( $this->options[ $var ] ) ) ? $this->options[ $var ] : '';
$this->label( $label . ':', array( 'for' => $var ) );
echo '<input 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 ), '"/>', '<br class="clear" />';
}
/**
* Create a textarea.
*
* @param string $var The variable within the option to create the textarea for.
* @param string $label The label to show for the variable.
* @param array $attr The CSS class to assign to the textarea.
*/
public function textarea( $var, $label, $attr = array() ) {
if ( ! is_array( $attr ) ) {
$attr = array(
'class' => $attr,
);
}
$attr = wp_parse_args( $attr, array(
'cols' => '',
'rows' => '',
'class' => '',
) );
$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 ) . ']">' . esc_textarea( $val ) . '</textarea>' . '<br class="clear" />';
}
/**
* Create a hidden input field.
*
* @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.
*
* @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 $values The select options to choose from.
*/
public function select( $var, $label, $values ) {
if ( ! is_array( $values ) || $values === array() ) {
return;
}
$val = ( isset( $this->options[ $var ] ) ) ? $this->options[ $var ] : '';
$this->label( $label . ':', array( 'for' => $var, 'class' => 'select' ) );
echo '<select class="select" name="', esc_attr( $this->option_name ), '[', esc_attr( $var ), ']" id="', esc_attr( $var ), '">';
foreach ( $values as $value => $label ) {
if ( ! empty( $label ) ) {
echo '<option value="', esc_attr( $value ), '"', selected( $val, $value, false ), '>', $label, '</option>';
}
}
echo '</select>';
echo '<br class="clear"/>';
}
/**
* Create a File upload field.
*
* @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 . '"/>';
// 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
*
* @param string $var
* @param string $label
*/
public function media_input( $var, $label ) {
$val = '';
if ( isset( $this->options[ $var ] ) ) {
$val = $this->options[ $var ];
}
$var_esc = esc_attr( $var );
$this->label( $label . ':', array( 'for' => 'wpseo_' . $var, 'class' => 'select' ) );
echo '<input class="textinput" id="wpseo_', $var_esc, '" type="text" size="36" name="', esc_attr( $this->option_name ), '[', $var_esc, ']" value="', esc_attr( $val ), '" />';
echo '<input id="wpseo_', $var_esc, '_button" class="wpseo_image_upload_button button" type="button" value="', __( 'Upload Image', 'wordpress-seo' ), '" />';
echo '<br class="clear"/>';
}
/**
* Create a Radio input field.
*
* @param string $var The variable within the option to create the file upload field for.
* @param array $values The radio options to choose from.
* @param string $label The label to show for the variable.
*/
public function radio( $var, $values, $label ) {
if ( ! is_array( $values ) || $values === array() ) {
return;
}
if ( ! isset( $this->options[ $var ] ) ) {
$this->options[ $var ] = false;
}
$var_esc = esc_attr( $var );
echo '<br/><div class="wpseo_radio_block" id="' . $var_esc . '">';
if ( is_string( $label ) && $label !== '' ) {
$this->label( $label . ':', array( 'class' => 'select' ) );
}
foreach ( $values as $key => $value ) {
$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 ) . ' />';
$this->label( $value, array( 'for' => $var_esc . '-' . $key_esc, 'class' => 'radio' ) );
}
echo '<div class="clear"></div>';
echo '</div><br/>';
}
}