class-config.php — Yoast SEO – Advanced SEO with real-time guidance and built-in AI 27.7

wordpress-seo / admin / class-config.php

wordpress-seo / admin Last commit date

class-config.php

162 lines

1	<?php
2	/**
3	* WPSEO plugin file.
4	*
5	* @package WPSEO\Admin
6	*/
7
8	use Yoast\WP\SEO\Actions\Alert_Dismissal_Action;
9	use Yoast\WP\SEO\General\User_Interface\General_Page_Integration;
10	use Yoast\WP\SEO\Integrations\Academy_Integration;
11	use Yoast\WP\SEO\Integrations\Admin\Redirects_Page_Integration;
12	use Yoast\WP\SEO\Integrations\Settings_Integration;
13	use Yoast\WP\SEO\Integrations\Support_Integration;
14	use Yoast\WP\SEO\Plans\User_Interface\Plans_Page_Integration;
15	use Yoast\WP\SEO\Promotions\Application\Promotion_Manager;
16
17	/**
18	* Class WPSEO_Admin_Pages.
19	*
20	* Class with functionality for the Yoast SEO admin pages.
21	*/
22	class WPSEO_Admin_Pages {
23
24	/**
25	* The option in use for the current admin page.
26	*
27	* @var string
28	*/
29	public $currentoption = 'wpseo';
30
31	/**
32	* Holds the asset manager.
33	*
34	* @var WPSEO_Admin_Asset_Manager
35	*/
36	private $asset_manager;
37
38	/**
39	* Class constructor, which basically only hooks the init function on the init hook.
40	*/
41	public function __construct() {
42	add_action( 'init', [ $this, 'init' ], 20 );
43
44	$this->asset_manager = new WPSEO_Admin_Asset_Manager();
45	}
46
47	/**
48	* Make sure the needed scripts are loaded for admin pages.
49	*
50	* @return void
51	*/
52	public function init() {
53	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
54	$page = isset( $_GET['page'] ) && is_string( $_GET['page'] ) ? sanitize_text_field( wp_unslash( $_GET['page'] ) ) : '';
55
56	// Don't load the scripts for the following pages.
57	$page_exceptions = in_array(
58	$page,
59	[
60	Settings_Integration::PAGE,
61	Academy_Integration::PAGE,
62	Support_Integration::PAGE,
63	Plans_Page_Integration::PAGE,
64	Redirects_Page_Integration::PAGE,
65	],
66	true,
67	);
68	$new_dashboard_page = ( $page === General_Page_Integration::PAGE && ! is_network_admin() );
69	if ( $page_exceptions \|\| $new_dashboard_page ) {
70	// Bail, this is managed in the applicable integration.
71	return;
72	}
73	add_action( 'admin_enqueue_scripts', [ $this, 'config_page_scripts' ] );
74	add_action( 'admin_enqueue_scripts', [ $this, 'config_page_styles' ] );
75	}
76
77	/**
78	* Loads the required styles for the config page.
79	*
80	* @return void
81	*/
82	public function config_page_styles() {
83	wp_enqueue_style( 'dashboard' );
84	wp_enqueue_style( 'thickbox' );
85	wp_enqueue_style( 'global' );
86	wp_enqueue_style( 'wp-admin' );
87	$this->asset_manager->enqueue_style( 'admin-css' );
88	$this->asset_manager->enqueue_style( 'monorepo' );
89	}
90
91	/**
92	* Loads the required scripts for the config page.
93	*
94	* @return void
95	*/
96	public function config_page_scripts() {
97	$this->asset_manager->enqueue_script( 'settings' );
98	wp_enqueue_script( 'dashboard' );
99	wp_enqueue_script( 'thickbox' );
100
101	$alert_dismissal_action = YoastSEO()->classes->get( Alert_Dismissal_Action::class );
102	$dismissed_alerts = $alert_dismissal_action->all_dismissed();
103
104	$script_data = [
105	'dismissedAlerts' => $dismissed_alerts,
106	'isRtl' => is_rtl(),
107	'isPremium' => YoastSEO()->helpers->product->is_premium(),
108	'currentPromotions' => YoastSEO()->classes->get( Promotion_Manager::class )
109	->get_current_promotions(),
110	'webinarIntroFirstTimeConfigUrl' => $this->get_webinar_shortlink(),
111	'linkParams' => WPSEO_Shortlinker::get_query_params(),
112	'pluginUrl' => plugins_url( '', WPSEO_FILE ),
113	];
114
115	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
116	$page = isset( $_GET['page'] ) && is_string( $_GET['page'] ) ? sanitize_text_field( wp_unslash( $_GET['page'] ) ) : '';
117
118	if ( in_array( $page, [ WPSEO_Admin::PAGE_IDENTIFIER, 'wpseo_workouts' ], true ) ) {
119	wp_enqueue_media();
120
121	$script_data['userEditUrl'] = add_query_arg( 'user_id', '{user_id}', admin_url( 'user-edit.php' ) );
122	}
123
124	if ( $page === 'wpseo_tools' ) {
125	$this->enqueue_tools_scripts();
126	}
127
128	$this->asset_manager->localize_script( 'settings', 'wpseoScriptData', $script_data );
129	}
130
131	/**
132	* Enqueues and handles all the tool dependencies.
133	*
134	* @return void
135	*/
136	private function enqueue_tools_scripts() {
137	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.
138	$tool = isset( $_GET['tool'] ) && is_string( $_GET['tool'] ) ? sanitize_text_field( wp_unslash( $_GET['tool'] ) ) : '';
139
140	if ( empty( $tool ) ) {
141	$this->asset_manager->enqueue_script( 'yoast-seo' );
142	}
143
144	if ( $tool === 'bulk-editor' ) {
145	$this->asset_manager->enqueue_script( 'bulk-editor' );
146	}
147	}
148
149	/**
150	* Returns the appropriate shortlink for the Webinar.
151	*
152	* @return string The shortlink for the Webinar.
153	*/
154	private function get_webinar_shortlink() {
155	if ( YoastSEO()->helpers->product->is_premium() ) {
156	return WPSEO_Shortlinker::get( 'https://yoa.st/webinar-intro-first-time-config-premium' );
157	}
158
159	return WPSEO_Shortlinker::get( 'https://yoa.st/webinar-intro-first-time-config' );
160	}
161	}
162