class-premium.php
15 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
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
<?php
/**
* @package Premium
*/
if ( ! defined( 'WPSEO_VERSION' ) ) {
header( 'HTTP/1.0 403 Forbidden' );
die;
}
if ( ! defined( 'WPSEO_PREMIUM_PATH' ) ) {
define( 'WPSEO_PREMIUM_PATH', plugin_dir_path( __FILE__ ) );
}
if ( ! defined( 'WPSEO_PREMIUM_FILE' ) ) {
define( 'WPSEO_PREMIUM_FILE', __FILE__ );
}
/**
* Class WPSEO_Premium
*/
class WPSEO_Premium {
const OPTION_CURRENT_VERSION = 'wpseo_current_version';
const PLUGIN_VERSION_NAME = '4.0.2';
const PLUGIN_VERSION_CODE = '16';
const PLUGIN_AUTHOR = 'Yoast';
const EDD_STORE_URL = 'http://my.yoast.com';
const EDD_PLUGIN_NAME = 'Yoast SEO Premium';
/**
* @var WPSEO_Redirect_Page
*/
private $redirects;
/**
* @var WPSEO_WordPress_Integration[]
*/
private $integrations = array();
/**
* Function that will be executed when plugin is activated
*/
public static function install() {
// Load the Redirect File Manager.
require_once( WPSEO_PREMIUM_PATH . 'classes/redirect/class-redirect-file-util.php' );
// Create the upload directory.
WPSEO_Redirect_File_Util::create_upload_dir();
WPSEO_Premium::activate_license();
}
/**
* Creates instance of license manager if needed and returns the instance of it.
*
* @return Yoast_Plugin_License_Manager
*/
public static function get_license_manager() {
static $license_manager;
if ( $license_manager === null ) {
$license_manager = new Yoast_Plugin_License_Manager( new WPSEO_Product_Premium() );
}
return $license_manager;
}
/**
* WPSEO_Premium Constructor
*/
public function __construct() {
$link_suggestions_service = new WPSEO_Premium_Link_Suggestions_Service();
$this->integrations = array(
'premium-metabox' => new WPSEO_Premium_Metabox(),
'prominent-words-registration' => new WPSEO_Premium_Prominent_Words_Registration(),
'prominent-words-endpoint' => new WPSEO_Premium_Prominent_Words_Endpoint( new WPSEO_Premium_Prominent_Words_Service() ),
'prominent-words-recalculation' => new WPSEO_Premium_Prominent_Words_Recalculation(),
'link-suggestions' => new WPSEO_Metabox_Link_Suggestions(),
'link-suggestions-endpoint' => new WPSEO_Premium_Link_Suggestions_Endpoint( $link_suggestions_service ),
);
$this->setup();
}
/**
* Adds a feature toggle to the given feature_toggles.
*
* @param array $feature_toggles The feature toggles to extend.
*
* @return array
*/
public function add_feature_toggles( array $feature_toggles ) {
$language = WPSEO_Utils::get_language( get_locale() );
if ( $language === 'en' ) {
$feature_toggles[] = (object) array(
'name' => __( 'Metabox insights', 'wordpress-seo-premium' ),
'setting' => 'enable_metabox_insights',
'label' => __( 'The metabox insights section contains insights about your content, like an overview of the most prominent words in your text.', 'wordpress-seo-premium' ),
);
}
return $feature_toggles;
}
/**
* Setup the Yoast SEO premium plugin
*/
private function setup() {
WPSEO_Premium::autoloader();
$this->load_textdomain();
$this->redirect_setup();
if ( is_admin() ) {
// Make sure priority is below registration of other implementations of the beacon in News, Video, etc.
add_action( 'admin_init', array( $this, 'init_helpscout_support' ), 1 );
add_filter( 'wpseo_feature_toggles', array( $this, 'add_feature_toggles' ) );
// Only register the yoast i18n when the page is a Yoast SEO page.
if ( $this->is_yoast_seo_premium_page( filter_input( INPUT_GET, 'page' ) ) ) {
$this->register_i18n_promo_class();
}
// Add custom fields plugin to post and page edit pages.
global $pagenow;
if ( in_array( $pagenow, array( 'post-new.php', 'post.php', 'edit.php' ) ) ) {
new WPSEO_Custom_Fields_Plugin();
}
// Disable Yoast SEO.
add_action( 'admin_init', array( $this, 'disable_wordpress_seo' ), 1 );
// Add Sub Menu page and add redirect page to admin page array.
// This should be possible in one method in the future, see #535.
add_filter( 'wpseo_submenu_pages', array( $this, 'add_submenu_pages' ), 9 );
// Add input fields to page meta post types.
add_action( 'wpseo_admin_page_meta_post_types', array(
$this,
'admin_page_meta_post_types_checkboxes',
), 10, 2 );
// Add page analysis fields to variable array key patterns.
add_filter( 'wpseo_option_titles_variable_array_key_patterns', array(
$this,
'add_variable_array_key_pattern',
) );
// Settings.
add_action( 'admin_init', array( $this, 'register_settings' ) );
// Licensing part.
$license_manager = WPSEO_Premium::get_license_manager();
// Setup constant name.
$license_manager->set_license_constant_name( 'WPSEO_LICENSE' );
// Setup license hooks.
$license_manager->setup_hooks();
// Add this plugin to licensing form.
add_action( 'wpseo_licenses_forms', array( $license_manager, 'show_license_form' ) );
if ( $license_manager->license_is_valid() ) {
add_action( 'admin_head', array( $this, 'admin_css' ) );
}
// Add Premium imports.
new WPSEO_Premium_Import_Manager();
// Only activate post and term watcher if permalink structure is enabled.
if ( get_option( 'permalink_structure' ) ) {
add_action( 'admin_init', array( $this, 'init_watchers' ) );
// Check if we need to display an admin message.
if ( $redirect_created = filter_input( INPUT_GET, 'yoast-redirect-created' ) ) {
// Message object.
$message = new WPSEO_Message_Redirect_Created( $redirect_created );
add_action( 'all_admin_notices', array( $message, 'display' ) );
}
}
}
else {
// Add 404 redirect link to WordPress toolbar.
add_action( 'admin_bar_menu', array( $this, 'admin_bar_menu' ), 96 );
add_filter( 'redirect_canonical', array( $this, 'redirect_canonical_fix' ), 1, 2 );
$dublin_core = new WPSEO_Dublin_Core();
}
add_action( 'admin_init', array( $this, 'enqueue_multi_keyword' ) );
add_action( 'admin_init', array( $this, 'enqueue_social_previews' ) );
add_action( 'wpseo_premium_indicator_classes', array( $this, 'change_premium_indicator' ) );
add_action( 'wpseo_premium_indicator_text', array( $this, 'change_premium_indicator_text' ) );
// Only initialize the AJAX for all tabs except settings.
$facebook_name = new WPSEO_Facebook_Profile();
$facebook_name->set_hooks();
foreach ( $this->integrations as $integration ) {
$integration->register_hooks();
}
}
/**
* Checks if the page is a premium page
*
* @param string $page The page to check.
*
* @return bool
*/
private function is_yoast_seo_premium_page( $page ) {
$premium_pages = array( 'wpseo_redirects' );
return in_array( $page, $premium_pages );
}
/**
* Register the promotion class for our GlotPress instance
*
* @link https://github.com/Yoast/i18n-module
*/
private function register_i18n_promo_class() {
new yoast_i18n(
array(
'textdomain' => 'wordpress-seo-premium',
'project_slug' => 'wordpress-seo-premium',
'plugin_name' => 'Yoast SEO premium',
'hook' => 'wpseo_admin_promo_footer',
'glotpress_url' => 'http://translate.yoast.com/gp/',
'glotpress_name' => 'Yoast Translate',
'glotpress_logo' => 'https://translate.yoast.com/gp-templates/images/Yoast_Translate.svg',
'register_url' => 'https://translate.yoast.com/gp/projects#utm_source=plugin&utm_medium=promo-box&utm_campaign=wpseo-i18n-promo',
)
);
}
/**
* Setting the autoloader for the redirects and instantiate the redirect page object
*/
private function redirect_setup() {
// Setting the autoloader for redirects.
new WPSEO_Premium_Autoloader( 'WPSEO_Redirect', 'redirect/', 'WPSEO_' );
$this->redirects = new WPSEO_Redirect_Page();
}
/**
* We might want to reactivate the license.
*/
private static function activate_license() {
$license_manager = self::get_license_manager();
$license_manager->activate_license();
}
/**
* Initialize the watchers for the posts and the terms
*/
public function init_watchers() {
// The Post Watcher.
new WPSEO_Post_Watcher();
// The Term Watcher.
new WPSEO_Term_Watcher();
}
/**
* Adds multi keyword functionality if we are on the correct pages
*/
public function enqueue_multi_keyword() {
global $pagenow;
if ( WPSEO_Metabox::is_post_edit( $pagenow ) ) {
new WPSEO_Multi_Keyword();
}
}
/**
* Adds multi keyword functionality if we are on the correct pages
*/
public function enqueue_social_previews() {
global $pagenow;
$metabox_pages = array(
'post-new.php',
'post.php',
'edit.php',
);
$social_previews = new WPSEO_Social_Previews();
if ( in_array( $pagenow , $metabox_pages, true ) || WPSEO_Taxonomy::is_term_edit( $pagenow ) ) {
$social_previews->set_hooks();
}
$social_previews->set_ajax_hooks();
}
/**
* Hooks into the `redirect_canonical` filter to catch ongoing redirects and move them to the correct spot
*
* @param string $redirect_url The target url where the requested URL will be redirected to.
* @param string $requested_url The current requested URL.
*
* @return string
*/
function redirect_canonical_fix( $redirect_url, $requested_url ) {
$redirects = apply_filters( 'wpseo_premium_get_redirects', get_option( 'wpseo-premium-redirects', array() ) );
$path = parse_url( $requested_url, PHP_URL_PATH );
if ( isset( $redirects[ $path ] ) ) {
$redirect_url = $redirects[ $path ]['url'];
if ( '/' === substr( $redirect_url, 0, 1 ) ) {
$redirect_url = home_url( $redirect_url );
}
wp_redirect( $redirect_url, $redirects[ $path ]['type'] );
exit;
}
return $redirect_url;
}
/**
* Disable Yoast SEO
*/
public function disable_wordpress_seo() {
if ( is_plugin_active( 'wordpress-seo/wp-seo.php' ) ) {
deactivate_plugins( 'wordpress-seo/wp-seo.php' );
}
}
/**
* Add 'Create Redirect' option to admin bar menu on 404 pages
*/
public function admin_bar_menu() {
if ( is_404() ) {
global $wp, $wp_admin_bar;
$parsed_url = parse_url( home_url( add_query_arg( null, null ) ) );
if ( false !== $parsed_url ) {
$old_url = $parsed_url['path'];
if ( isset( $parsed_url['query'] ) && $parsed_url['query'] != '' ) {
$old_url .= '?' . $parsed_url['query'];
}
$old_url = urlencode( $old_url );
$wp_admin_bar->add_menu( array(
'id' => 'wpseo-premium-create-redirect',
'title' => __( 'Create Redirect', 'wordpress-seo-premium' ),
'href' => admin_url( 'admin.php?page=wpseo_redirects&old_url=' . $old_url ),
) );
}
}
}
/**
* Add page analysis to array with variable array key patterns
*
* @param array $patterns Array with patterns for page analysis.
*
* @return array
*/
public function add_variable_array_key_pattern( $patterns ) {
if ( true !== in_array( 'page-analyse-extra-', $patterns ) ) {
$patterns[] = 'page-analyse-extra-';
}
return $patterns;
}
/**
* This hook will add an input-field for specifying custom fields for page analysis.
*
* The values will be comma-seperated and will target the belonging field in the post_meta. Page analysis will
* use the content of it by sticking it to the post_content.
*
* @param array $wpseo_admin_pages Unused. Array with admin pages.
* @param string $name The name for the text input field.
*/
public function admin_page_meta_post_types_checkboxes( $wpseo_admin_pages, $name ) {
echo Yoast_Form::get_instance()->textinput( 'page-analyse-extra-' . $name, __( 'Add custom fields to page analysis', 'wordpress-seo-premium' ) );
}
/**
* Function adds the premium pages to the Yoast SEO menu
*
* @param array $submenu_pages Array with the configuration for the submenu pages.
*
* @return array
*/
public function add_submenu_pages( $submenu_pages ) {
/**
* Filter: 'wpseo_premium_manage_redirects_role' - Change the minimum rule to access and change the site redirects
*
* @api string manage_options
*/
$submenu_pages[] = array(
'wpseo_dashboard',
'',
__( 'Redirects', 'wordpress-seo-premium' ),
apply_filters( 'wpseo_premium_manage_redirects_role', 'manage_options' ),
'wpseo_redirects',
array( $this->redirects, 'display' ),
);
return $submenu_pages;
}
/**
* Change premium indicator to green when premium is enabled
*
* @param string[] $classes The current classes for the indicator.
* @returns string[] The new classes for the indicator.
*/
public function change_premium_indicator( $classes ) {
$class_no = array_search( 'wpseo-premium-indicator--no', $classes );
if ( false !== $class_no ) {
unset( $classes[ $class_no ] );
$classes[] = 'wpseo-premium-indicator--yes';
}
return $classes;
}
/**
* Replaces the screen reader text for the premium indicator.
*
* @param string $text The original text.
* @return string The new text.
*/
public function change_premium_indicator_text( $text ) {
return __( 'Enabled', 'wordpress-seo-premium' );
}
/**
* Add redirects to admin pages so the Yoast scripts are loaded
*
* @param array $admin_pages Array with the admin pages.
*
* @return array
* @deprecated 3.1
*/
public function add_admin_pages( $admin_pages ) {
_deprecated_function( 'WPSEO_Premium::add_admin_pages', 'WPSEO 3.1' );
return $admin_pages;
}
/**
* Register the premium settings
*/
public function register_settings() {
register_setting( 'yoast_wpseo_redirect_options', 'wpseo_redirect' );
}
/**
* Output admin css in admin head
*/
public function admin_css() {
echo "<style type='text/css'>#wpseo_content_top{ padding-left: 0; margin-left: 0; }</style>";
}
/**
* Load textdomain
*/
private function load_textdomain() {
load_plugin_textdomain( 'wordpress-seo-premium', false, dirname( plugin_basename( WPSEO_FILE ) ) . '/premium/languages/' );
}
/**
* Loads the autoloader
*/
public static function autoloader() {
if ( ! class_exists( 'WPSEO_Premium_Autoloader', false ) ) {
// Setup autoloader.
require_once( dirname( __FILE__ ) . '/classes/class-premium-autoloader.php' );
$autoloader = new WPSEO_Premium_Autoloader( 'WPSEO_', '' );
}
}
/**
* Initializes the helpscout support modal for wpseo settings pages
*/
public function init_helpscout_support() {
$query_var = ( $page = filter_input( INPUT_GET, 'page' ) ) ? $page : '';
// Only add the helpscout beacon on Yoast SEO pages.
if ( in_array( $query_var, $this->get_beacon_pages() ) ) {
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_contact_support' ) );
$beacon = yoast_get_helpscout_beacon( $query_var, 'no_search' );
$beacon->add_setting( new WPSEO_Premium_Beacon_Setting() );
$beacon->register_hooks();
}
}
/**
* Get the pages the Premium beacon should be displayed on
*
* @return array
*/
private function get_beacon_pages() {
return array(
'wpseo_dashboard',
'wpseo_titles',
'wpseo_social',
'wpseo_xml',
'wpseo_advanced',
'wpseo_tools',
'wpseo_search_console',
'wpseo_licenses',
);
}
/**
* Add the Yoast contact support assets
*/
public function enqueue_contact_support() {
wp_enqueue_script( 'yoast-contact-support', plugin_dir_url( WPSEO_PREMIUM_FILE ) . 'assets/js/dist/wpseo-premium-contact-support-370' . WPSEO_CSSJS_SUFFIX . '.js', array( 'jquery' ), WPSEO_VERSION );
}
}