Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
92.03%
254 / 276
70.00%
21 / 30
 CRAP
0.00%
0 / 1
Admin_Menu
92.03%
254 / 276
70.00%
21 / 30
 116.13
0.00%
0 / 1
 init
100.00%
8 / 8
100.00%
1 / 1
 2
 reset
100.00%
14 / 14
100.00%
1 / 1
 1
 handle_akismet_menu
100.00%
5 / 5
100.00%
1 / 1
 3
 take_over_akismet_menu
100.00%
3 / 3
100.00%
1 / 1
 1
 admin_menu_hook_callback
96.00%
48 / 50
0.00%
0 / 1
 12
 init_top_level
100.00%
4 / 4
100.00%
1 / 1
 2
 top_level_menu_hook_callback
100.00%
16 / 16
100.00%
1 / 1
 4
 add_top_level_menu
100.00%
3 / 3
100.00%
1 / 1
 1
 add_menu
100.00%
9 / 9
100.00%
1 / 1
 4
 hide_core_admin_notices
100.00%
4 / 4
100.00%
1 / 1
 2
 print_hide_core_admin_notices_style
n/a
0 / 0
n/a
0 / 0
 1
 get_hide_core_admin_notices_styles
100.00%
2 / 2
100.00%
1 / 1
 1
 set_visibility_resolver
100.00%
1 / 1
100.00%
1 / 1
 1
 remove_hidden_menu_items
100.00%
4 / 4
100.00%
1 / 1
 3
 get_item_key
100.00%
3 / 3
100.00%
1 / 1
 2
 get_visibility_states
100.00%
8 / 8
100.00%
1 / 1
 4
 is_menu_item_visible
100.00%
7 / 7
100.00%
1 / 1
 3
 is_gate_satisfied
100.00%
6 / 6
100.00%
1 / 1
 5
 remove_menu
0.00%
0 / 5
0.00%
0 / 1
 12
 get_top_level_menu_item_slug
71.43%
5 / 7
0.00%
0 / 1
 5.58
 get_top_level_menu_item_url
0.00%
0 / 6
0.00%
0 / 1
 12
 should_show_upgrade_menu
92.31%
12 / 13
0.00%
0 / 1
 7.02
 is_site_and_user_connected
70.00%
7 / 10
0.00%
0 / 1
 8.32
 set_connection_manager
100.00%
1 / 1
100.00%
1 / 1
 1
 is_free_plan
100.00%
11 / 11
100.00%
1 / 1
 9
 maybe_add_upgrade_menu_item
95.00%
19 / 20
0.00%
0 / 1
 8
 add_upgrade_menu_item_styles
100.00%
11 / 11
100.00%
1 / 1
 3
 enqueue_design_tokens
100.00%
5 / 5
100.00%
1 / 1
 2
 register_design_tokens_style
90.00%
9 / 10
0.00%
0 / 1
 3.01
 maybe_enqueue_design_tokens
100.00%
3 / 3
100.00%
1 / 1
 2
 enqueue_upgrade_menu_tracks_script
96.30%
26 / 27
0.00%
0 / 1
 5
1<?php
2/**
3 * Admin Menu Registration
4 *
5 * @package automattic/jetpack-admin-ui
6 */
7
8namespace Automattic\Jetpack\Admin_UI;
9
10use Automattic\Jetpack\Feature_Policy;
11use Automattic\Jetpack\Tracking;
12use Jetpack_Options;
13use Jetpack_Tracks_Client;
14
15/**
16 * This class offers a wrapper to add_submenu_page and makes sure stand-alone plugin's menu items are always added under the Jetpack top level menu.
17 * If the Jetpack top level was not previously registered by other plugin, it will be registered here.
18 */
19class Admin_Menu {
20
21    const PACKAGE_VERSION = '0.14.9';
22
23    /**
24     * Slug used for the upgrade menu item and redirect URL.
25     *
26     * Keep the slug in sync with `$upgrade-menu-slug` at admin-ui-upgrade-menu.scss
27     *
28     * @var string
29     */
30    const UPGRADE_MENU_SLUG = 'jetpack-wpadmin-sidebar-free-plan-upsell-menu-item';
31
32    /**
33     * Fallback upgrade URL when the Redirect class is unavailable.
34     *
35     * @var string
36     */
37    const UPGRADE_MENU_FALLBACK_URL = 'https://jetpack.com/upgrade/';
38
39    /*
40     * The sidebar's position tiers. Items sharing a tier sort alphabetically by menu title, so a
41     * product should pass no position and land in POSITION_DEFAULT. add_menu() treats any value
42     * that is not a tier below as omitted, so an int of your own cannot opt an item out.
43     */
44
45    /**
46     * Owns the top-level Jetpack link, since WordPress points it at whichever item sorts first.
47     *
48     * @var int
49     */
50    const POSITION_FIRST = -10;
51
52    /**
53     * Takes the first slot when nothing claims POSITION_FIRST, as in offline mode.
54     *
55     * @var int
56     */
57    const POSITION_FIRST_FALLBACK = -5;
58
59    /**
60     * Products, in alphabetical order. Pass no position rather than this.
61     *
62     * @var int
63     */
64    const POSITION_DEFAULT = 0;
65
66    /**
67     * Links that leave wp-admin, grouped below the products.
68     *
69     * @var int
70     */
71    const POSITION_EXTERNAL = 100;
72
73    /**
74     * Site-level items that belong under everything else.
75     *
76     * @var int
77     */
78    const POSITION_LAST = 998;
79
80    /**
81     * The upgrade item this package adds, below every tier a caller can use.
82     *
83     * @var int
84     */
85    const POSITION_UPGRADE = 999;
86
87    /**
88     * The tiers add_menu() accepts. POSITION_UPGRADE is left out: only this class claims it.
89     *
90     * @var int[]
91     */
92    private const CALLER_POSITIONS = array(
93        self::POSITION_FIRST,
94        self::POSITION_FIRST_FALLBACK,
95        self::POSITION_DEFAULT,
96        self::POSITION_EXTERNAL,
97        self::POSITION_LAST,
98    );
99
100    /**
101     * Handle for the bundled WPDS design-tokens stylesheet.
102     *
103     * Fallback when Core/Gutenberg has not registered the `wp-theme` style.
104     *
105     * @var string
106     */
107    const DESIGN_TOKENS_HANDLE = 'jetpack-admin-ui-design-tokens';
108
109    /**
110     * Handle for the source-less stylesheet that hides WordPress core admin notices.
111     *
112     * @var string
113     */
114    const HIDE_CORE_NOTICES_HANDLE = 'jetpack-admin-ui-hide-core-notices';
115
116    /**
117     * Visibility state: show the item only when its declared gate is satisfied.
118     *
119     * @var string
120     */
121    const VISIBILITY_DEFAULT = 'default';
122
123    /**
124     * Visibility state: show the item whatever its gate says.
125     *
126     * @var string
127     */
128    const VISIBILITY_VISIBLE = 'visible';
129
130    /**
131     * Visibility state: keep the item out whatever its gate says.
132     *
133     * @var string
134     */
135    const VISIBILITY_HIDDEN = 'hidden';
136
137    /**
138     * Whether this class has been initialized
139     *
140     * @var boolean
141     */
142    private static $initialized = false;
143
144    /**
145     * List of menu items enqueued to be added
146     *
147     * @var array
148     */
149    private static $menu_items = array();
150
151    /**
152     * List of top level menu items enqueued to be added
153     *
154     * @var array
155     */
156    private static $top_level_items = array();
157
158    /**
159     * Hook suffixes of the pages registered through this class.
160     *
161     * Used to scope the design-tokens stylesheet to Jetpack admin pages.
162     *
163     * @var array
164     */
165    private static $page_hooks = array();
166
167    /**
168     * Optional connection manager dependency.
169     *
170     * @var object|null
171     */
172    private static $connection_manager = null;
173
174    /**
175     * Callback that answers whether a menu item's declared gate is satisfied.
176     *
177     * Set by My Jetpack, which owns the product classes the gates name. Stays null on a
178     * site without it, where every gate then fails open.
179     *
180     * @var callable|null
181     */
182    private static $visibility_resolver = null;
183
184    /**
185     * Menu slugs registered this request but kept out of the rendered sidebar.
186     *
187     * @var string[]
188     */
189    private static $hidden_menu_slugs = array();
190
191    /**
192     * Top level menu slugs registered this request but kept out of the rendered sidebar.
193     *
194     * @var string[]
195     */
196    private static $hidden_top_level_slugs = array();
197
198    /**
199     * Whether the top level registration pass has been hooked.
200     *
201     * Separate from $initialized, which also builds the Jetpack menu.
202     *
203     * @var boolean
204     */
205    private static $top_level_initialized = false;
206
207    /**
208     * Initialize the class and set up the main hook
209     *
210     * @return void
211     */
212    public static function init() {
213        if ( ! self::$initialized ) {
214            self::$initialized = true;
215            self::handle_akismet_menu();
216            add_action( 'admin_menu', array( __CLASS__, 'admin_menu_hook_callback' ), 1000 ); // Jetpack uses 998.
217            add_action( 'network_admin_menu', array( __CLASS__, 'admin_menu_hook_callback' ), 1000 ); // Jetpack uses 998.
218            add_action( 'admin_head', array( __CLASS__, 'remove_hidden_menu_items' ) );
219            add_action( 'admin_enqueue_scripts', array( __CLASS__, 'add_upgrade_menu_item_styles' ) );
220            add_action( 'admin_enqueue_scripts', array( __CLASS__, 'maybe_enqueue_design_tokens' ) );
221        }
222    }
223
224    /**
225     * Drops every queued item and unhooks the registration passes.
226     *
227     * Intended for tests.
228     *
229     * @return void
230     */
231    public static function reset() {
232        self::$menu_items             = array();
233        self::$top_level_items        = array();
234        self::$page_hooks             = array();
235        self::$hidden_menu_slugs      = array();
236        self::$hidden_top_level_slugs = array();
237        self::$initialized            = false;
238        self::$top_level_initialized  = false;
239
240        remove_action( 'admin_menu', array( __CLASS__, 'take_over_akismet_menu' ), 4 );
241        remove_action( 'admin_menu', array( __CLASS__, 'admin_menu_hook_callback' ), 1000 );
242        remove_action( 'network_admin_menu', array( __CLASS__, 'admin_menu_hook_callback' ), 1000 );
243        remove_action( 'admin_menu', array( __CLASS__, 'top_level_menu_hook_callback' ), 1000 );
244        remove_action( 'admin_head', array( __CLASS__, 'remove_hidden_menu_items' ) );
245        remove_action( 'admin_enqueue_scripts', array( __CLASS__, 'add_upgrade_menu_item_styles' ) );
246        remove_action( 'admin_enqueue_scripts', array( __CLASS__, 'maybe_enqueue_design_tokens' ) );
247    }
248
249    /**
250     * Registers the Akismet menu item through this class, so it sorts with the rest of the Jetpack menu.
251     *
252     * Akismet hooks admin_menu at priority 5 and, when the Jetpack plugin is active, defers its entry to
253     * jetpack_admin_menu, which fires before this class registers its sorted items.
254     */
255    private static function handle_akismet_menu() {
256        if ( ! class_exists( 'Akismet_Admin' ) ) {
257            return;
258        }
259
260        // Initialized after priority 5, as when My Jetpack is the first caller: Akismet has already deferred.
261        if ( has_action( 'jetpack_admin_menu', array( 'Akismet_Admin', 'load_menu' ) ) ) {
262            self::take_over_akismet_menu();
263        } else {
264            add_action( 'admin_menu', array( __CLASS__, 'take_over_akismet_menu' ), 4 );
265        }
266    }
267
268    /**
269     * Stops Akismet from adding its own menu item and queues ours in its place.
270     *
271     * @return void
272     */
273    public static function take_over_akismet_menu() {
274        // Older Jetpack plugins unhook Akismet's admin_menu callback themselves and rely on this item.
275        remove_action( 'admin_menu', array( 'Akismet_Admin', 'admin_menu' ), 5 );
276        remove_action( 'jetpack_admin_menu', array( 'Akismet_Admin', 'load_menu' ) );
277
278        self::add_menu( __( 'Akismet Anti-spam', 'jetpack-admin-ui' ), __( 'Akismet Anti-spam', 'jetpack-admin-ui' ), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
279    }
280
281    /**
282     * Callback to the admin_menu and network_admin_menu hooks that will register the enqueued menu items
283     *
284     * @return void
285     */
286    public static function admin_menu_hook_callback() {
287        $can_see_toplevel_menu  = true;
288        $jetpack_plugin_present = class_exists( 'Jetpack_React_Page' );
289        $icon                   = 'dashicons-admin-plugins';
290        if ( method_exists( '\Automattic\Jetpack\Assets\Logo', 'get_base64_admin_menu_logo' ) ) {
291            $icon = ( new \Automattic\Jetpack\Assets\Logo() )->get_base64_admin_menu_logo();
292        } elseif ( method_exists( '\Automattic\Jetpack\Assets\Logo', 'get_base64_logo' ) ) {
293            $icon = ( new \Automattic\Jetpack\Assets\Logo() )->get_base64_logo();
294        }
295
296        if ( ! $jetpack_plugin_present ) {
297            add_menu_page(
298                'Jetpack',
299                'Jetpack',
300                'edit_posts',
301                'jetpack',
302                '__return_null',
303                $icon,
304                3
305            );
306
307            // If Jetpack plugin is not present, user will only be able to see this menu if they have enough capability to at least one of the sub menus being added.
308            $can_see_toplevel_menu = false;
309        }
310
311        /*
312         * Sort here and register in that order, without passing the position on: core splices an
313         * int back in, and prepends 0 or less. See https://core.trac.wordpress.org/ticket/52035.
314         */
315        usort(
316            self::$menu_items,
317            function ( $a, $b ) {
318                $position_a = empty( $a['position'] ) ? 0 : $a['position'];
319                $position_b = empty( $b['position'] ) ? 0 : $b['position'];
320                $result     = $position_a <=> $position_b;
321
322                if ( 0 === $result ) {
323                    // Case-insensitive and number-aware, so "eCommerce" sorts with the Es.
324                    // Still a byte compare: a leading accented character sorts after Z.
325                    $result = strnatcasecmp( $a['menu_title'], $b['menu_title'] );
326                }
327
328                return $result;
329            }
330        );
331
332        $visibility = self::get_visibility_states();
333
334        self::$hidden_menu_slugs = array();
335
336        foreach ( self::$menu_items as $menu_item ) {
337            if ( ! current_user_can( $menu_item['capability'] ) ) {
338                continue;
339            }
340
341            /*
342             * A hidden item is still registered, so its page keeps resolving for links into it.
343             * It leaves the submenu on admin_head instead: core's access check reads $submenu.
344             */
345            if ( self::is_menu_item_visible( $menu_item, $visibility ) ) {
346                $can_see_toplevel_menu = true;
347            } else {
348                self::$hidden_menu_slugs[] = $menu_item['menu_slug'];
349            }
350
351            add_submenu_page(
352                'jetpack',
353                $menu_item['page_title'],
354                $menu_item['menu_title'],
355                $menu_item['capability'],
356                $menu_item['menu_slug'],
357                $menu_item['function']
358            );
359        }
360
361        if ( ! $jetpack_plugin_present ) {
362            remove_submenu_page( 'jetpack', 'jetpack' );
363        }
364
365        if ( ! $can_see_toplevel_menu ) {
366            remove_menu_page( 'jetpack' );
367        }
368
369        self::maybe_add_upgrade_menu_item();
370    }
371
372    /**
373     * Hooks the top level registration pass, without building the Jetpack menu that init() does.
374     *
375     * @return void
376     */
377    private static function init_top_level() {
378        if ( ! self::$top_level_initialized ) {
379            self::$top_level_initialized = true;
380            add_action( 'admin_menu', array( __CLASS__, 'top_level_menu_hook_callback' ), 1000 );
381            add_action( 'admin_head', array( __CLASS__, 'remove_hidden_menu_items' ) );
382        }
383    }
384
385    /**
386     * Registers the queued top level items, skipping the ones that should not be seen.
387     *
388     * These sit beside the Jetpack menu, so they never count towards keeping it alive.
389     *
390     * @return void
391     */
392    public static function top_level_menu_hook_callback() {
393        $visibility = self::get_visibility_states();
394
395        self::$hidden_top_level_slugs = array();
396
397        foreach ( self::$top_level_items as $menu_item ) {
398            if ( ! current_user_can( $menu_item['capability'] ) ) {
399                continue;
400            }
401
402            if ( ! self::is_menu_item_visible( $menu_item, $visibility ) ) {
403                self::$hidden_top_level_slugs[] = $menu_item['menu_slug'];
404            }
405
406            add_menu_page(
407                $menu_item['page_title'],
408                $menu_item['menu_title'],
409                $menu_item['capability'],
410                $menu_item['menu_slug'],
411                $menu_item['function'],
412                $menu_item['icon_url'],
413                $menu_item['position']
414            );
415        }
416    }
417
418    /**
419     * Adds a top level menu item under the same visibility gate and filter as add_menu().
420     *
421     * Unlike add_menu(), the page gets neither the core-notice CSS nor the design tokens.
422     * Parameters mirror add_menu_page(), with $args appended.
423     *
424     * @since 0.13.0
425     *
426     * @param string        $page_title The text to be displayed in the title tags of the page when the menu
427     *                                  is selected.
428     * @param string        $menu_title The text to be used for the menu.
429     * @param string        $capability The capability required for this menu to be displayed to the user.
430     * @param string        $menu_slug  The slug name to refer to this menu by. Should be unique for this menu.
431     * @param callable|null $function   The function to be called to output the content for this page.
432     * @param string        $icon_url   The URL to the icon to be used for this menu, or a dashicons class.
433     * @param int|null      $position   The position in the menu order this item should appear.
434     * @param array         $args       Optional. Visibility declaration for this item; see add_menu().
435     *
436     * @return string The resulting page's hook_suffix
437     */
438    public static function add_top_level_menu( $page_title, $menu_title, $capability, $menu_slug, $function, $icon_url = '', $position = null, $args = array() ) {
439        self::init_top_level();
440        self::$top_level_items[] = compact( 'page_title', 'menu_title', 'capability', 'menu_slug', 'function', 'icon_url', 'position', 'args' );
441
442        // Same derivation as get_plugin_page_hookname(), which strips ".php" anywhere in the slug.
443        return 'toplevel_page_' . preg_replace( '!\.php!', '', plugin_basename( $menu_slug ) );
444    }
445
446    /**
447     * Adds a new submenu to the Jetpack Top level menu
448     *
449     * The parameters this method accepts are the same as @see add_submenu_page. This class will
450     * aggreagate all menu items registered by stand-alone plugins and make sure they all go under the same
451     * Jetpack top level menu. It will also handle the top level menu registration in case the Jetpack plugin is not present.
452     *
453     * @param string        $page_title  The text to be displayed in the title tags of the page when the menu
454     *                                   is selected.
455     * @param string        $menu_title  The text to be used for the menu.
456     * @param string        $capability  The capability required for this menu to be displayed to the user.
457     * @param string        $menu_slug   The slug name to refer to this menu by. Should be unique for this menu
458     *                                   and only include lowercase alphanumeric, dashes, and underscores characters
459     *                                   to be compatible with sanitize_key().
460     * @param callable|null $function    The function to be called to output the content for this page.
461     * @param int|null      $position    One of the POSITION_* tiers; any other value is ignored. Leave empty typically.
462     * @param array         $args        Optional. Visibility declaration for this item:
463     *                                   - 'product' (string) My Jetpack product slug whose activation gates the item.
464     *                                   - 'module'  (string) Jetpack module name, for items with no product class.
465     *                                   - 'key'     (string) The name hosts use for this item in the visibility
466     *                                                        filter. Declare one on every item; see get_item_key().
467     *                                   An item that declares no gate is always shown.
468     *
469     * @return string The resulting page's hook_suffix
470     */
471    public static function add_menu( $page_title, $menu_title, $capability, $menu_slug, $function, $position = null, $args = array() ) {
472        self::init();
473
474        /*
475         * Anything but a tier would opt the item out of the alphabetical order, so treat it as omitted.
476         * @todo Add _doing_it_wrong() here after December 2026. Until all our own plugins ship tier-only
477         * positions, it would have the latest release of one Jetpack plugin warning about another.
478         */
479        $position = is_numeric( $position ) && in_array( (int) $position, self::CALLER_POSITIONS, true ) ? (int) $position : null;
480
481        self::$menu_items[] = compact( 'page_title', 'menu_title', 'capability', 'menu_slug', 'function', 'position', 'args' );
482
483        /**
484         * Let's return the page hook so consumers can use.
485         * Pages normally sit under the Jetpack top level menu page, so we can hardcode the first part of the string.
486         * Using get_plugin_page_hookname here won't work because the top level page is not registered yet.
487         */
488        $hook = 'jetpack_page_' . $menu_slug;
489
490        // Core names the page admin_page_<slug> instead when the user has no Jetpack top-level menu.
491        foreach ( array( $hook, 'admin_page_' . $menu_slug ) as $page_hook ) {
492            // Track the page hook so the design-tokens stylesheet can be scoped to it.
493            self::$page_hooks[] = $page_hook;
494
495            // Hide WordPress core admin notices on this Jetpack page. The load-<hook>
496            // action only fires when the matching screen is being rendered, so this
497            // stays scoped to Jetpack pages and reaches every page registered here.
498            add_action( 'load-' . $page_hook, array( __CLASS__, 'hide_core_admin_notices' ) );
499            add_action( 'load-' . $page_hook . '-network', array( __CLASS__, 'hide_core_admin_notices' ) );
500        }
501
502        return $hook;
503    }
504
505    /**
506     * Enqueues the stylesheet that hides WordPress core admin notices on the current Jetpack page.
507     *
508     * Hooked from the page's load-<hook> action so it only runs on Jetpack screens. That action
509     * runs before admin_enqueue_scripts, so the handle is queued in time to be printed.
510     *
511     * @return void
512     */
513    public static function hide_core_admin_notices() {
514        // wp_add_inline_style() appends, so the CSS is attached only while the handle is new to the request.
515        if ( ! wp_style_is( self::HIDE_CORE_NOTICES_HANDLE, 'registered' ) ) {
516            wp_register_style( self::HIDE_CORE_NOTICES_HANDLE, false, array(), self::PACKAGE_VERSION );
517            wp_add_inline_style( self::HIDE_CORE_NOTICES_HANDLE, self::get_hide_core_admin_notices_styles() );
518        }
519
520        wp_enqueue_style( self::HIDE_CORE_NOTICES_HANDLE );
521    }
522
523    /**
524     * Enqueues the CSS that hides WordPress core admin notices.
525     *
526     * Callers must run this before WordPress flushes the style queue in
527     * print_admin_styles() (admin_print_styles, priority 20). Later than that,
528     * the handle is never printed. The previous admin_print_styles priority-10
529     * hook still works.
530     *
531     * @deprecated 0.10.0 Use hide_core_admin_notices(), which enqueues the CSS.
532     *
533     * @return void
534     */
535    public static function print_hide_core_admin_notices_style() {
536        _deprecated_function( __METHOD__, 'admin-ui-0.10.0', __CLASS__ . '::hide_core_admin_notices' );
537        self::hide_core_admin_notices();
538    }
539
540    /**
541     * Gets the CSS that hides WordPress core admin notices.
542     *
543     * We only target direct children of #wpbody-content (where core renders notices via the
544     * admin_notices / all_admin_notices hooks). This intentionally leaves JITMs untouched —
545     * they output `.jetpack-jitm-message`, not `.notice` — and leaves in-app/React notices
546     * untouched, since those render deeper inside `.wrap`. The CSS rides on a source-less
547     * handle rather than a build asset so it also reaches older Jetpack pages that ship no
548     * stylesheet of their own.
549     *
550     * @return string CSS rules.
551     */
552    private static function get_hide_core_admin_notices_styles() {
553        return '
554        #wpbody-content > .notice,
555        #wpbody-content > .update-nag,
556        #wpbody-content > .updated,
557        #wpbody-content > .error { display: none !important; }
558        ';
559    }
560
561    /**
562     * Sets the callback that resolves a menu item's declared gate.
563     *
564     * The callback receives the item's $args array and returns true (gate satisfied),
565     * false (not satisfied), or null when it cannot answer — an unknown product slug,
566     * for instance. Null is treated as satisfied, so a gate this package cannot resolve
567     * never removes a menu item.
568     *
569     * This is the seam My Jetpack fills. Hosts wanting to shape the sidebar should use the
570     * `jetpack_admin_menu_visibility` filter instead, which takes precedence: an item the
571     * filter names is never put to this callback at all.
572     *
573     * @param callable|null $resolver Resolver callback, or null to clear it.
574     * @return void
575     */
576    public static function set_visibility_resolver( $resolver ) {
577        self::$visibility_resolver = $resolver;
578    }
579
580    /**
581     * Takes hidden items out of the sidebar before it renders.
582     *
583     * Runs on admin_head, after core's access check has already resolved the current page,
584     * so a hidden item's page stays reachable while its entry disappears.
585     *
586     * @return void
587     */
588    public static function remove_hidden_menu_items() {
589        foreach ( self::$hidden_menu_slugs as $menu_slug ) {
590            remove_submenu_page( 'jetpack', plugin_basename( $menu_slug ) );
591        }
592
593        foreach ( self::$hidden_top_level_slugs as $menu_slug ) {
594            remove_menu_page( plugin_basename( $menu_slug ) );
595        }
596    }
597
598    /**
599     * Returns the name a host uses for a menu item in the visibility filter.
600     *
601     * The menu slug is only a fallback. It is the wrong thing to hand a host as an identifier:
602     * several items register a URL as their slug, Blaze's is filterable, and VideoPress swaps
603     * between two slugs depending on whether the module is active — so a host naming one of
604     * them is naming a moving target, or only half an item.
605     *
606     * @param array $menu_item A registered menu item.
607     * @return string
608     */
609    private static function get_item_key( array $menu_item ) {
610        if ( ! empty( $menu_item['args']['key'] ) ) {
611            return (string) $menu_item['args']['key'];
612        }
613
614        return (string) $menu_item['menu_slug'];
615    }
616
617    /**
618     * Builds the item => state map and hands it to hosts to amend.
619     *
620     * @return array Map of item key to one of the VISIBILITY_* states.
621     */
622    private static function get_visibility_states() {
623        // This filter is one a policy feeds, and nothing else need have read the policy this request.
624        if ( method_exists( Feature_Policy::class, 'ensure_hooks' ) ) {
625            Feature_Policy::ensure_hooks();
626        }
627
628        $states = array();
629        $items  = array_merge( self::$menu_items, self::$top_level_items );
630
631        foreach ( $items as $menu_item ) {
632            $states[ self::get_item_key( $menu_item ) ] = self::VISIBILITY_DEFAULT;
633        }
634
635        /**
636         * Filters which Jetpack items appear in the wp-admin sidebar.
637         *
638         * Governs the sidebar entry only — a hidden item's page stays reachable by URL, so this
639         * is not an access control. States: 'default' follows the item's feature, 'visible' shows it, 'hidden' removes it.
640         * `jetpack_feature_policy` runs after this. Item keys and examples:
641         * https://github.com/Automattic/jetpack/blob/trunk/projects/packages/admin-ui/README.md#host-control
642         *
643         * @since 0.12.0
644         *
645         * @param array $states     Map of item key (menu slug unless the item declared one) to state.
646         * @param array $menu_items The registered menu items, each with its menu_slug, capability, and args.
647         */
648        $states = apply_filters( 'jetpack_admin_menu_visibility', $states, $items );
649
650        return is_array( $states ) ? $states : array();
651    }
652
653    /**
654     * Decides whether a single menu item should appear in the sidebar.
655     *
656     * @param array $menu_item  A registered menu item.
657     * @param array $visibility The resolved state map from get_visibility_states().
658     * @return bool
659     */
660    private static function is_menu_item_visible( array $menu_item, array $visibility ) {
661        $key   = self::get_item_key( $menu_item );
662        $state = $visibility[ $key ] ?? self::VISIBILITY_DEFAULT;
663
664        if ( self::VISIBILITY_HIDDEN === $state ) {
665            return false;
666        }
667
668        if ( self::VISIBILITY_VISIBLE === $state ) {
669            return true;
670        }
671
672        return self::is_gate_satisfied( $menu_item['args'] ?? array() );
673    }
674
675    /**
676     * Asks the resolver whether an item's declared gate is satisfied.
677     *
678     * Everything here fails open. An item that declares no gate, a site with no resolver
679     * registered, and a gate the resolver does not recognize all keep the item in the
680     * sidebar, so adopting this mechanism cannot remove an item nobody asked it to.
681     *
682     * @param array $args The item's visibility declaration.
683     * @return bool
684     */
685    private static function is_gate_satisfied( array $args ) {
686        if ( ! isset( $args['product'] ) && ! isset( $args['module'] ) ) {
687            return true;
688        }
689
690        if ( ! is_callable( self::$visibility_resolver ) ) {
691            return true;
692        }
693
694        $resolved = call_user_func( self::$visibility_resolver, $args );
695
696        return null === $resolved ? true : (bool) $resolved;
697    }
698
699    /**
700     * Removes an already added submenu
701     *
702     * @param string $menu_slug   The slug of the submenu to remove.
703     *
704     * @return array|false The removed submenu on success, false if not found.
705     */
706    public static function remove_menu( $menu_slug ) {
707
708        foreach ( self::$menu_items as $index => $menu_item ) {
709            if ( $menu_item['menu_slug'] === $menu_slug ) {
710                unset( self::$menu_items[ $index ] );
711
712                return $menu_item;
713            }
714        }
715
716        return false;
717    }
718
719    /**
720     * Gets the slug for the first item under the Jetpack top level menu
721     *
722     * Skips hidden items rather than reading $submenu alone, because callers on admin_enqueue_scripts
723     * and outside wp-admin ask before — or without — the admin_head pass that drops them.
724     *
725     * @return string|null
726     */
727    public static function get_top_level_menu_item_slug() {
728        global $submenu;
729
730        if ( empty( $submenu['jetpack'] ) ) {
731            return null;
732        }
733
734        $hidden = array_map( 'plugin_basename', self::$hidden_menu_slugs );
735
736        foreach ( $submenu['jetpack'] as $item ) {
737            if ( isset( $item[2] ) && ! in_array( $item[2], $hidden, true ) ) {
738                return $item[2];
739            }
740        }
741
742        return null;
743    }
744
745    /**
746     * Gets the URL for the first item under the Jetpack top level menu
747     *
748     * @param string $fallback If Jetpack menu is not there or no children is found, return this fallback instead. Default to admin_url().
749     * @return string
750     */
751    public static function get_top_level_menu_item_url( $fallback = false ) {
752        $slug = self::get_top_level_menu_item_slug();
753
754        if ( $slug ) {
755            $url = menu_page_url( $slug, false );
756            return $url;
757        }
758
759        $url = $fallback ? $fallback : admin_url();
760        return $url;
761    }
762
763    /**
764     * Checks whether the current site should show the upgrade menu item.
765     *
766     * The upgrade menu is only shown to administrators on free-plan sites
767     * that are not hosted on WordPress.com.
768     *
769     * @return bool True if the upgrade menu should be shown.
770     */
771    private static function should_show_upgrade_menu() {
772
773        // Only show to administrators.
774        if ( ! current_user_can( 'manage_options' ) ) {
775            return false;
776        }
777
778        // Don't show upsells on WordPress.com platform.
779        if ( class_exists( '\Automattic\Jetpack\Status\Host' ) ) {
780            $host = new \Automattic\Jetpack\Status\Host();
781            if ( $host->is_wpcom_platform() ) {
782                return false;
783            }
784        }
785
786        // Don't show upsells in offline/development mode.
787        if ( class_exists( '\Automattic\Jetpack\Status' ) ) {
788            $status = new \Automattic\Jetpack\Status();
789            if ( $status->is_offline_mode() ) {
790                return false;
791            }
792        }
793
794        // Only show after the site and current user are connected.
795        if ( ! self::is_site_and_user_connected() ) {
796            return false;
797        }
798
799        // Only show to free-plan sites.
800        return self::is_free_plan();
801    }
802
803    /**
804     * Checks whether the site and current user are connected to WordPress.com.
805     *
806     * @return bool True if site and current user are connected.
807     */
808    private static function is_site_and_user_connected() {
809        $connection_manager = self::$connection_manager;
810        if ( ! $connection_manager && class_exists( '\Automattic\Jetpack\Connection\Manager' ) ) {
811            $connection_manager       = new \Automattic\Jetpack\Connection\Manager();
812            self::$connection_manager = $connection_manager;
813        }
814
815        if (
816            $connection_manager
817            && is_callable( array( $connection_manager, 'is_connected' ) )
818            && is_callable( array( $connection_manager, 'is_user_connected' ) )
819        ) {
820            return (bool) $connection_manager->is_connected()
821                && (bool) $connection_manager->is_user_connected( get_current_user_id() );
822        }
823
824        return false;
825    }
826
827    /**
828     * Sets the connection manager dependency; used by tests.
829     *
830     * @param object|null $connection_manager Connection manager object.
831     * @return void
832     */
833    public static function set_connection_manager( $connection_manager ) {
834        self::$connection_manager = $connection_manager;
835    }
836
837    /**
838     * Checks whether the current site is on a free Jetpack plan with no active paid license.
839     *
840     * @return bool True if the site has no paid plan.
841     */
842    private static function is_free_plan() {
843        // Check the active plan - use the is_free field or product_slug.
844        $plan = get_option( 'jetpack_active_plan', array() );
845
846        // Back-compat: older plan payloads use class to indicate paid plans.
847        if ( isset( $plan['class'] ) && 'free' !== $plan['class'] ) {
848            return false;
849        }
850
851        // If the plan explicitly says it's not free, trust that.
852        if ( isset( $plan['is_free'] ) && false === $plan['is_free'] ) {
853            return false;
854        }
855
856        // Check if the product slug indicates a paid plan.
857        if ( isset( $plan['product_slug'] ) && 'jetpack_free' !== $plan['product_slug'] ) {
858            return false;
859        }
860
861        // Also check for site products (licenses can add products without changing plan).
862        $products = get_option( 'jetpack_site_products', array() );
863        if ( ! empty( $products ) && is_array( $products ) ) {
864            return false;
865        }
866
867        return true;
868    }
869
870    /**
871     * Conditionally adds an "Upgrade Jetpack" submenu item for free-plan sites.
872     *
873     * Only shown to users with manage_options capability on self-hosted sites without a paid Jetpack plan or license.
874     *
875     * @return void
876     */
877    private static function maybe_add_upgrade_menu_item() {
878        if ( ! self::should_show_upgrade_menu() ) {
879            return;
880        }
881
882        $upgrade_url = class_exists( '\Automattic\Jetpack\Redirect' )
883            ? \Automattic\Jetpack\Redirect::get_url( self::UPGRADE_MENU_SLUG )
884            : self::UPGRADE_MENU_FALLBACK_URL;
885
886        $menu_title = esc_html__( 'Upgrade Jetpack', 'jetpack-admin-ui' );
887
888        add_submenu_page(
889            'jetpack',
890            $menu_title,
891            $menu_title,
892            'manage_options',
893            esc_url( $upgrade_url ),
894            null, // @phan-suppress-current-line PhanTypeMismatchArgumentProbablyReal -- Core should ideally document null for no-callback arg. https://core.trac.wordpress.org/ticket/52539.
895            self::POSITION_UPGRADE
896        );
897
898        // Add a CSS class to the <li> element so styles can target it precisely.
899        global $submenu;
900        if ( ! empty( $submenu['jetpack'] ) ) {
901            foreach ( $submenu['jetpack'] as $index => $item ) {
902                if ( isset( $item[2] ) && false !== strpos( $item[2], self::UPGRADE_MENU_SLUG ) ) {
903                    // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
904                    $submenu['jetpack'][ $index ][4] = ( ! empty( $item[4] ) ? $item[4] . ' ' : '' ) . self::UPGRADE_MENU_SLUG;
905                    break;
906                }
907            }
908        }
909    }
910
911    /**
912     * Enqueues admin styles for the "Upgrade Jetpack" menu item.
913     *
914     * The sidebar menu is visible on every admin page, so styles load globally.
915     * Only enqueues for free-plan sites on self-hosted installs.
916     *
917     * @return void
918     */
919    public static function add_upgrade_menu_item_styles() {
920        if ( ! self::should_show_upgrade_menu() ) {
921            return;
922        }
923
924        $asset_file = dirname( __DIR__ ) . '/build/admin-ui-upgrade-menu.asset.php';
925        $asset      = file_exists( $asset_file ) ? require $asset_file : array();
926
927        wp_enqueue_style(
928            'jetpack-admin-ui-upgrade-menu',
929            plugins_url( '../build/admin-ui-upgrade-menu.css', __FILE__ ),
930            $asset['dependencies'] ?? array(),
931            $asset['version'] ?? self::PACKAGE_VERSION
932        );
933
934        self::enqueue_upgrade_menu_tracks_script( $asset );
935    }
936
937    /**
938     * Enqueues WPDS design tokens so `var(--wpds-*)` values resolve at runtime.
939     *
940     * Prefer Core/Gutenberg's `wp-theme` style when registered; otherwise ship
941     * the bundled copy. The caller scopes the call to the right page(s).
942     *
943     * @return void
944     */
945    public static function enqueue_design_tokens() {
946        // Registered since WP 7.1 (and by Gutenberg):
947        // https://make.wordpress.org/core/2026/07/31/design-system-theming-in-wordpress-7-1/
948        if ( wp_style_is( 'wp-theme', 'registered' ) ) {
949            wp_enqueue_style( 'wp-theme' );
950            return;
951        }
952
953        // @todo Remove this, the called function, and the webpack entrypoint it registers when WP 7.1 is the minimum version.
954        self::register_design_tokens_style();
955        wp_enqueue_style( self::DESIGN_TOKENS_HANDLE );
956    }
957
958    /**
959     * Registers the bundled, token-only WPDS design-tokens stylesheet.
960     *
961     * Used only when `wp-theme` is not registered. Safe to call repeatedly:
962     * wp_register_style() is a no-op once the handle is registered.
963     *
964     * @return void
965     */
966    private static function register_design_tokens_style() {
967        if ( wp_style_is( self::DESIGN_TOKENS_HANDLE, 'registered' ) ) {
968            return;
969        }
970
971        $asset_file = dirname( __DIR__ ) . '/build/design-tokens.asset.php';
972        $asset      = file_exists( $asset_file ) ? require $asset_file : array();
973
974        wp_register_style(
975            self::DESIGN_TOKENS_HANDLE,
976            plugins_url( '../build/design-tokens.css', __FILE__ ),
977            $asset['dependencies'] ?? array(),
978            $asset['version'] ?? self::PACKAGE_VERSION
979        );
980    }
981
982    /**
983     * Enqueues the design tokens on the pages registered through this class.
984     *
985     * This is the admin_enqueue_scripts callback for the modernized Jetpack
986     * dashboards. Scoped to self::$page_hooks so the tokens load wherever a
987     * modernized dashboard renders, regardless of plan or connection state; the
988     * actual enqueue is delegated to the reusable enqueue_design_tokens() API.
989     *
990     * @param string $hook_suffix The current admin page's hook suffix.
991     * @return void
992     */
993    public static function maybe_enqueue_design_tokens( $hook_suffix ) {
994        if ( ! in_array( $hook_suffix, self::$page_hooks, true ) ) {
995            return;
996        }
997
998        self::enqueue_design_tokens();
999    }
1000
1001    /**
1002     * Enqueues Tracks for the upgrade submenu item.
1003     *
1004     * @param array $asset Parsed contents of admin-ui-upgrade-menu.asset.php.
1005     * @return void
1006     */
1007    private static function enqueue_upgrade_menu_tracks_script( $asset ) {
1008        if ( ! class_exists( '\Automattic\Jetpack\Tracking' ) ) {
1009            return;
1010        }
1011
1012        Tracking::register_tracks_functions_scripts( true );
1013
1014        wp_enqueue_script(
1015            'jetpack-admin-ui-upgrade-menu-tracking',
1016            plugins_url( '../build/admin-ui-upgrade-menu-tracking.js', __FILE__ ),
1017            $asset['dependencies'] ?? array(),
1018            $asset['version'] ?? self::PACKAGE_VERSION,
1019            true
1020        );
1021
1022        $current_screen   = get_current_screen();
1023        $is_admin         = current_user_can( 'jetpack_disconnect' );
1024        $site_id          = class_exists( 'Jetpack_Options' ) ? Jetpack_Options::get_option( 'id' ) : null;
1025        $tracks_user_data = class_exists( 'Jetpack_Tracks_Client' ) ? Jetpack_Tracks_Client::get_connected_user_tracks_identity() : null;
1026
1027        wp_localize_script(
1028            'jetpack-admin-ui-upgrade-menu-tracking',
1029            'jetpackAdminUiUpgradeMenu',
1030            array(
1031                'menuItemClass'   => self::UPGRADE_MENU_SLUG,
1032                'tracksUserData'  => $tracks_user_data,
1033                'tracksEventData' => array(
1034                    'is_admin'       => $is_admin,
1035                    'current_screen' => $current_screen ? $current_screen->id : false,
1036                    'blog_id'        => $site_id,
1037                ),
1038            )
1039        );
1040    }
1041}