← All changes | class.jetpack-admin.php +154 -72 12.7.3 → 16.2 View file →

		@@ -4,13 +4,18 @@
4	4	*
5	5	* @package automattic/jetpack
6	6	*/
7	7
	8	+use Automattic\Jetpack\Admin_UI\Admin_Menu;
8	9	use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
9	10	use Automattic\Jetpack\Partner_Coupon as Jetpack_Partner_Coupon;
10	11	use Automattic\Jetpack\Status;
11	12	use Automattic\Jetpack\Status\Host;
12	13
	14	+if ( ! defined( 'ABSPATH' ) ) {
	15	+ exit( 0 );
	16	+}
	17	+
13	18	/**
14	19	* Build the Jetpack admin menu as a whole.
15	20	*/
16	21	class Jetpack_Admin {
		@@ -27,13 +32,8 @@
27	32	*
28	33	* @return self
29	34	*/
30	35	public static function init() {
31		- // phpcs:ignore WordPress.Security.NonceVerification.Recommended
32		- if ( isset( $_GET['page'] ) && 'jetpack' === $_GET['page'] ) {
33		- add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
34		- }
35		-
36	36	if ( self::$instance === null ) {
37	37	self::$instance = new Jetpack_Admin();
38	38	}
39	39	return self::$instance;
		@@ -41,12 +41,14 @@
41	41
42	42	/**
43	43	* Filter callback to add `no-store` to the `Cache-Control` header.
44	44	*
	45	+ * @deprecated 14.9
45	46	* @param array $headers Headers array.
46	47	* @return array Modified headers array.
47	48	*/
48	49	public static function add_no_store_header( $headers ) {
	50	+ _deprecated_function( __METHOD__, '14.9' );
49	51	$headers['Cache-Control'] .= ', no-store';
50	52	return $headers;
51	53	}
52	54
		@@ -60,15 +62,19 @@
60	62
61	63	require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class-jetpack-about-page.php';
62	64	$jetpack_about = new Jetpack_About_Page();
63	65
	66	+ require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class-jetpack-ai-page.php';
	67	+ $jetpack_ai = new Jetpack_AI_Page();
	68	+
64	69	add_action( 'admin_init', array( $jetpack_react, 'react_redirects' ), 0 );
65	70	add_action( 'admin_menu', array( $jetpack_react, 'add_actions' ), 998 );
66		- add_action( 'jetpack_admin_menu', array( $jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) );
	71	+ add_action( 'admin_menu', array( $jetpack_react, 'remove_jetpack_menu' ), 2000 );
67	72	add_action( 'jetpack_admin_menu', array( $jetpack_react, 'jetpack_add_settings_sub_nav_item' ) );
68	73	add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) );
69	74	add_action( 'jetpack_admin_menu', array( $fallback_page, 'add_actions' ) );
70	75	add_action( 'jetpack_admin_menu', array( $jetpack_about, 'add_actions' ) );
	76	+ add_action( 'jetpack_admin_menu', array( $jetpack_ai, 'add_actions' ) );
71	77
72	78	// Add redirect to current page for activation/deactivation of modules.
73	79	add_action( 'jetpack_pre_activate_module', array( $this, 'fix_redirect' ), 10, 2 );
74	80	add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ), 10, 2 );
		@@ -80,9 +86,9 @@
80	86	// If the site has Jetpack Anti-spam, change the Akismet menu label and logo accordingly.
81	87	$site_products = array_column( Jetpack_Plan::get_products(), 'product_slug' );
82	88	$has_anti_spam_product = count( array_intersect( array( 'jetpack_anti_spam', 'jetpack_anti_spam_monthly' ), $site_products ) ) > 0;
83	89
84		- if ( Jetpack_Plan::supports( 'antispam' ) || $has_anti_spam_product ) {
	90	+ if ( Jetpack_Plan::supports( 'akismet' ) || Jetpack_Plan::supports( 'antispam' ) || $has_anti_spam_product ) {
85	91	// Prevent Akismet from adding a menu item.
86	92	add_action(
87	93	'admin_menu',
88	94	function () {
		@@ -90,17 +96,18 @@
90	96	},
91	97	4
92	98	);
93	99
94		- // Add an Anti-spam menu item for Jetpack.
95		- add_action(
96		- 'jetpack_admin_menu',
97		- function () {
98		- add_submenu_page( 'jetpack', __( 'Anti-Spam', 'jetpack' ), __( 'Anti-Spam', 'jetpack' ), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
99		- }
100		- );
101		- add_action( 'admin_enqueue_scripts', array( $this, 'akismet_logo_replacement_styles' ) );
	100	+ // Add an Anti-spam menu item for Jetpack. This is handled automatically by the Admin_Menu as long as it has been initialized.
	101	+ Admin_Menu::init();
102	102	}
	103	+
	104	+ // Render the unified Jetpack header/footer chrome on Akismet's admin pages by
	105	+ // consuming Akismet's `akismet_header` / `akismet_footer` action hooks. This does
	106	+ // not modify the Akismet plugin; it only registers callbacks on its own hooks.
	107	+ require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class-akismet-admin-chrome.php';
	108	+ $akismet_admin_chrome = new Akismet_Admin_Chrome();
	109	+ $akismet_admin_chrome->init_hooks();
103	110	}
104	111
105	112	// Ensure an Additional CSS menu item is added to the Appearance menu whenever Jetpack is connected.
106	113	add_action( 'admin_menu', array( $this, 'additional_css_menu' ) );
		@@ -108,19 +115,19 @@
108	115	add_filter( 'jetpack_display_jitms_on_screen', array( $this, 'should_display_jitms_on_screen' ), 10, 2 );
109	116
110	117	// Register Jetpack partner coupon hooks.
111	118	Jetpack_Partner_Coupon::register_coupon_admin_hooks( 'jetpack', Jetpack::admin_url() );
112		- }
113	119
114		- /**
115		- * Generate styles to replace Akismet logo for the Jetpack Akismet Anti-spam logo.
116		- Without this, we would have to change the logo from Akismet codebase and we want to avoid that.
117		- */
118		- public function akismet_logo_replacement_styles() {
119		- $logo_url = esc_url( plugins_url( 'images/products/logo-anti-spam.svg', JETPACK__PLUGIN_FILE ) );
120		- $style = ".akismet-masthead__logo-container { background: url({$logo_url}) no-repeat; min-height: 42px; margin: 20px 0; padding: 0 !important; } .akismet-masthead__logo { display: none; }";
121		- $style .= '@media screen and (max-width: 782px) { .akismet-masthead__logo-container { margin-left: 4px; } }';
122		- wp_add_inline_style( 'admin-bar', $style );
	120	+ // Remove default WordPress admin footer on Jetpack pages only.
	121	+ add_filter( 'admin_footer_text', array( $this, 'maybe_remove_admin_footer_text' ) );
	122	+ add_filter( 'update_footer', array( $this, 'maybe_remove_admin_footer_version' ), 11 );
	123	+ add_filter( 'admin_body_class', array( $this, 'add_jetpack_admin_body_class' ) );
	124	+ add_action( 'admin_head', array( $this, 'add_footer_removal_styles' ) );
	125	+
	126	+ // Make WPDS design tokens resolve at runtime on the legacy/wrap_ui Jetpack
	127	+ // admin pages (Dashboard, Settings, Debugger) that don't ship their own
	128	+ // `:root{--wpds-*}` source. Delegates to Admin_Menu's shared enqueue API.
	129	+ add_action( 'admin_enqueue_scripts', array( $this, 'maybe_enqueue_design_tokens' ) );
123	130	}
124	131
125	132	/**
126	133	* Handle our Additional CSS menu item and legacy page declaration.
		@@ -142,9 +149,14 @@
142	149	// If the site is a WoA site and the custom-css feature is not available, return.
143	150	// See https://github.com/Automattic/jetpack/pull/19965 for more on how this menu item is dealt with on WoA sites.
144	151	if ( ( new Host() )->is_woa_site() && ! ( in_array( 'custom-css', Jetpack::get_available_modules(), true ) ) ) {
145	152	return;
146		- } elseif ( class_exists( 'Jetpack' ) && Jetpack::is_module_active( 'custom-css' ) ) { // If the Custom CSS module is enabled, add the Additional CSS menu item and link to the Customizer.
	153	+ } elseif (
	154	+ class_exists( 'Jetpack' ) && (
	155	+ Jetpack::is_module_active( 'custom-css' ) || // If the Custom CSS module is enabled, add the Additional CSS menu item and link to the Customizer.
	156	+ ( wp_is_block_theme() && ! empty( wp_get_custom_css() ) ) // Do the same if the theme is block-based but has existing custom CSS.
	157	+ )
	158	+ ) {
147	159	// Add in our legacy page to support old bookmarks and such.
148	160	add_submenu_page( '', __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss', array( __CLASS__, 'customizer_redirect' ) );
149	161
150	162	// Add in our new page slug that will redirect to the customizer.
		@@ -149,13 +161,8 @@
149	161
150	162	// Add in our new page slug that will redirect to the customizer.
151	163	$hook = add_theme_page( __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss-customizer-redirect', array( __CLASS__, 'customizer_redirect' ) );
152	164	add_action( "load-{$hook}", array( __CLASS__, 'customizer_redirect' ) );
153		- } elseif ( class_exists( 'Jetpack' ) && Jetpack::is_connection_ready() ) { // Link to the Jetpack Settings > Writing page, highlighting the Custom CSS setting.
154		- add_submenu_page( '', __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss', array( __CLASS__, 'theme_enhancements_redirect' ) );
155		-
156		- $hook = add_theme_page( __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss-theme-enhancements-redirect', array( __CLASS__, 'theme_enhancements_redirect' ) );
157		- add_action( "load-{$hook}", array( __CLASS__, 'theme_enhancements_redirect' ) );
158	165	}
159	166	}
160	167
161	168	/**
		@@ -166,8 +173,10 @@
166	173	*
167	174	* There is a core patch in trac that would make this unnecessary.
168	175	*
169	176	* @link https://core.trac.wordpress.org/ticket/39050
	177	+ *
	178	+ * @return never
170	179	*/
171	180	public static function customizer_redirect() {
172	181	wp_safe_redirect(
173	182	self::customizer_link(
		@@ -175,24 +184,12 @@
175	184	'return_url' => wp_get_referer(),
176	185	)
177	186	)
178	187	);
179		- exit;
	188	+ exit( 0 );
180	189	}
181	190
182	191	/**
183		- * Handle the Additional CSS redirect to the Jetpack settings Theme Enhancements section.
184		- *
185		- * @since 11.0
186		- */
187		- public static function theme_enhancements_redirect() {
188		- wp_safe_redirect(
189		- 'admin.php?page=jetpack#/writing?term=custom-css'
190		- );
191		- exit;
192		- }
193		-
194		- /**
195	192	* Build the URL to deep link to the Customizer.
196	193	*
197	194	* You can modify the return url via $args.
198	195	*
		@@ -231,17 +228,9 @@
231	228	* @param array $module2 Module data.
232	229	* @return int Indicating the relative ordering of module1 and module2.
233	230	*/
234	231	public static function sort_requires_connection_last( $module1, $module2 ) {
235		- if ( (bool) $module1['requires_connection'] === (bool) $module2['requires_connection'] ) {
236		- return 0;
237		- } elseif ( $module1['requires_connection'] ) {
238		- return 1;
239		- } elseif ( $module2['requires_connection'] ) {
240		- return -1;
241		- }
242		-
243		- return 0;
	232	+ return ( (bool) $module1['requires_connection'] ) <=> ( (bool) $module2['requires_connection'] );
244	233	}
245	234
246	235	/**
247	236	* Produce JS understandable objects of modules containing information for
		@@ -332,9 +321,9 @@
332	321	* add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
333	322	*
334	323	* @since 3.5.0
335	324	*
336		- * @param string The search terms (comma separated).
	325	+ * @param string The search terms (comma-separated).
337	326	*/
338	327	echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
339	328	$module_array['search_terms'] = ob_get_clean();
340	329
		@@ -465,9 +454,9 @@
465	454	* level connection should be unavailable.
466	455	*/
467	456	if ( ( new Status() )->is_offline_mode() ) {
468	457	if ( $module['requires_connection'] || $module['requires_user_connection'] ) {
469		- return __( 'Offline mode', 'jetpack' );
	458	+ return __( 'Unavailable in Offline mode', 'jetpack' );
470	459	}
471	460	}
472	461
473	462	/*
		@@ -513,9 +502,9 @@
513	502	Jetpack::activate_module( $module, false );
514	503	}
515	504	// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
516	505	wp_safe_redirect( wp_get_referer() );
517		- exit;
	506	+ exit( 0 );
518	507	case 'bulk-deactivate':
519	508	check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
520	509	if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
521	510	break;
		@@ -528,9 +517,9 @@
528	517	Jetpack::state( 'message', 'module_deactivated' );
529	518	}
530	519	Jetpack::state( 'module', $modules );
531	520	wp_safe_redirect( wp_get_referer() );
532		- exit;
	521	+ exit( 0 );
533	522	default:
534	523	return;
535	524	}
536	525	}
		@@ -577,9 +566,15 @@
577	566	nocache_headers();
578	567	if ( ! current_user_can( 'manage_options' ) ) {
579	568	die( '-1' );
580	569	}
581		- Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ), array( 'is-wide' => true ) );
	570	+ Jetpack_Admin_Page::wrap_ui(
	571	+ array( $this, 'debugger_page' ),
	572	+ array(
	573	+ 'is-wide' => true,
	574	+ 'show-nav' => false,
	575	+ )
	576	+ );
582	577	}
583	578
584	579	/**
585	580	* Display debugger page.
		@@ -610,24 +605,111 @@
610	605	) ) {
611	606	return false;
612	607	}
613	608
614		- // Disable all JITMs on pages where the recommendations banner is displaying.
615		- if (
616		- in_array(
617		- $screen_id,
618		- array(
619		- 'dashboard',
620		- 'plugins',
621		- 'jetpack_page_stats',
622		- ),
623		- true
624		- )
625		- && \Jetpack_Recommendations_Banner::can_be_displayed()
626		- ) {
	609	+ return $value;
	610	+ }
	611	+
	612	+ /**
	613	+ * Check if we're on a Jetpack admin page.
	614	+ *
	615	+ * Similar to how WooCommerce checks for its admin pages by comparing
	616	+ * against known screen ID patterns.
	617	+ *
	618	+ * @return bool True if on a Jetpack admin page, false otherwise.
	619	+ */
	620	+ private function is_jetpack_admin_page() {
	621	+ $screen = get_current_screen();
	622	+ if ( ! $screen ) {
627	623	return false;
628	624	}
629	625
630		- return $value;
	626	+ // Check for Jetpack admin pages:
	627	+ // - toplevel_page_jetpack (main Jetpack menu page)
	628	+ // - toplevel_page_jetpack-network (Jetpack Network Admin menu page)
	629	+ // - jetpack_page_* (Jetpack submenu pages)
	630	+ // - admin_page_jetpack* (legacy/special Jetpack pages)
	631	+ // Or check if parent_base is 'jetpack' or 'jetpack-network' (submenu pages)
	632	+ return (
	633	+ $screen->id === 'toplevel_page_jetpack' ||
	634	+ $screen->id === 'toplevel_page_jetpack-network' ||
	635	+ str_starts_with( $screen->id, 'jetpack_page_' ) ||
	636	+ str_starts_with( $screen->id, 'admin_page_jetpack' ) ||
	637	+ $screen->parent_base === 'jetpack' ||
	638	+ $screen->parent_base === 'jetpack-network'
	639	+ );
	640	+ }
	641	+
	642	+ /**
	643	+ * Add a body class to Jetpack admin pages.
	644	+ *
	645	+ * @param string $classes Space-separated list of CSS classes.
	646	+ * @return string Modified class list.
	647	+ */
	648	+ public function add_jetpack_admin_body_class( $classes ) {
	649	+ if ( $this->is_jetpack_admin_page() ) {
	650	+ return ltrim( trim( $classes ) . ' jetpack-admin-page ' );
	651	+ }
	652	+ return $classes;
	653	+ }
	654	+
	655	+ /**
	656	+ * Add inline styles to remove footer padding on Jetpack pages.
	657	+ *
	658	+ * This needs to be inline because jetpack-admin.css is not loaded on
	659	+ * React-powered admin pages (they use load_wrapper_styles instead).
	660	+ */
	661	+ public function add_footer_removal_styles() {
	662	+ if ( ! $this->is_jetpack_admin_page() ) {
	663	+ return;
	664	+ }
	665	+ echo '<style>.jetpack-admin-page #wpbody-content { padding-bottom: 0; } .jetpack-admin-page #wpfooter { display: none; }</style>';
	666	+ }
	667	+
	668	+ /**
	669	+ * Enqueues the shared WPDS design-tokens stylesheet on the legacy/wrap_ui pages.
	670	+ *
	671	+ * This is the admin_enqueue_scripts callback for the legacy Jetpack admin
	672	+ * pages. The admin-ui package owns the handle and enqueues it on the
	673	+ * modernized dashboards it registers; the legacy/wrap_ui pages (Dashboard,
	674	+ * Settings, Debugger) aren't registered through Admin_Menu, so we cover them
	675	+ * here via the central is_jetpack_admin_page() gate. The actual enqueue is
	676	+ * delegated to the reusable Admin_Menu::enqueue_design_tokens() API so there
	677	+ * is a single owner of the handle and no duplicated register/enqueue logic.
	678	+ *
	679	+ * @return void
	680	+ */
	681	+ public function maybe_enqueue_design_tokens() {
	682	+ if ( ! $this->is_jetpack_admin_page() ) {
	683	+ return;
	684	+ }
	685	+
	686	+ // Guard against an older admin-ui being loaded ahead of this one by the
	687	+ // package autoloader's version-precedence resolution.
	688	+ if ( ! method_exists( Admin_Menu::class, 'enqueue_design_tokens' ) ) {
	689	+ return;
	690	+ }
	691	+
	692	+ Admin_Menu::enqueue_design_tokens();
	693	+ }
	694	+
	695	+ /**
	696	+ * Remove the admin footer text on Jetpack pages.
	697	+ *
	698	+ * @param string $content The default footer text.
	699	+ * @return string Empty string on Jetpack pages, original content otherwise.
	700	+ */
	701	+ public function maybe_remove_admin_footer_text( $content ) {
	702	+ return $this->is_jetpack_admin_page() ? '' : $content;
	703	+ }
	704	+
	705	+ /**
	706	+ * Remove the admin footer version on Jetpack pages.
	707	+ *
	708	+ * @param string $content The default footer version text.
	709	+ * @return string Empty string on Jetpack pages, original content otherwise.
	710	+ */
	711	+ public function maybe_remove_admin_footer_version( $content ) {
	712	+ return $this->is_jetpack_admin_page() ? '' : $content;
631	713	}
632	714	}
633	715	Jetpack_Admin::init();