Admin_Menu - Code Metrics - Inspection of "Merge branch 'master' into deprecate/render-nudge" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — deprecate/render-nudge ( a7bfad...8c35c9 )

unknown

created 2021-01-04 17:19 UTC

Admin_Menu B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	440
Duplicated Lines	15 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

Metric	Value
dl	66
loc	440
rs	7.44
c	0
b	0
f	0
wmc	52
lcom	2
cbo	1

20 Methods

Rating	Name	Duplication	Size	Complexity
A	get_instance()	0	9	2
A	__construct()	0	9	1
A	rest_api_init()	0	3	1
A	reregister_menu_items()	0	38	3
A	add_my_home_menu()	0	17	3
A	add_stats_menu()	0	3	1
A	add_upgrades_menu()	0	11	1
A	add_posts_menu()	18	18	2
A	add_media_menu()	0	12	2
A	add_page_menu()	17	17	2
A	add_comments_menu()	0	21	3
C	add_appearance_menu()	26	49	12
A	add_plugins_menu()	0	3	1
A	add_users_menu()	0	21	4
A	add_tools_menu()	0	21	2
A	add_options_menu()	0	6	2
A	migrate_submenus()	0	14	4
A	add_admin_menu_separator()	0	14	1
A	enqueue_scripts()	5	22	4
A	dequeue_scripts()	0	3	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Admin_Menu often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Admin_Menu, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Admin Menu file.
 *
 * @package Jetpack
 */

namespace Automattic\Jetpack\Dashboard_Customizations;

use Automattic\Jetpack\Status;

/**
 * Class Admin_Menu.
 */
class Admin_Menu {
	/**
	 * Holds class instances.
	 *
	 * @var array
	 */
	protected static $instances;

	/**
	 * Whether the current request is a REST API request.
	 *
	 * @var bool
	 */
	protected $is_api_request = false;

	/**
	 * Domain of the current site.
	 *
	 * @var string
	 */
	protected $domain;

	/**
	 * Admin_Menu constructor.
	 */
	protected function __construct() {
		add_action( 'admin_menu', array( $this, 'reregister_menu_items' ), 99999 );
		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
		add_action( 'wp_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );
		add_action( 'admin_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );
		add_action( 'rest_request_before_callbacks', array( $this, 'rest_api_init' ), 11 );

		$this->domain = ( new Status() )->get_site_suffix();
	}

	/**
	 * Returns class instance.
	 *
	 * @return Admin_Menu
	 */
	public static function get_instance() {
		$class = get_called_class();

		if ( empty( static::$instances[ $class ] ) ) {
			static::$instances[ $class ] = new $class();
		}

		return static::$instances[ $class ];
	}

	/**
	 * Sets up class properties for REST API requests.
	 */
	public function rest_api_init() {
		$this->is_api_request = true;
	}

	/**
	 * Create the desired menu output.
	 */
	public function reregister_menu_items() {
		// Constant is not defined until parse_request.
		if ( ! $this->is_api_request ) {
			$this->is_api_request = defined( 'REST_REQUEST' ) && REST_REQUEST;
		}

		/**
		 * Whether links should point to Calypso or wp-admin.
		 *
		 * Options:
		 * true  - Calypso.
		 * false - wp-admin.
		 *
		 * @module masterbar
		 * @since 9.3.0
		 *
		 * @param bool $calypso Whether menu item URLs should point to Calypso.
		 */
		$calypso = apply_filters( 'jetpack_admin_menu_use_calypso_links', true );

		// Remove separators.
		remove_menu_page( 'separator1' );

		$this->add_my_home_menu( $calypso );
		$this->add_stats_menu();
		$this->add_upgrades_menu();
		$this->add_posts_menu( $calypso );
		$this->add_media_menu( $calypso );
		$this->add_page_menu( $calypso );
		$this->add_comments_menu( $calypso );
		$this->add_appearance_menu( $calypso );
		$this->add_plugins_menu();
		$this->add_users_menu( $calypso );
		$this->add_tools_menu( $calypso );
		$this->add_options_menu();

		ksort( $GLOBALS['menu'] );
	}

	/**
	 * Adds My Home menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_my_home_menu( $calypso = true ) {
		global $submenu;

		$menu_slug = $calypso ? 'https://wordpress.com/home/' . $this->domain : 'index.php';

		remove_menu_page( 'index.php' );
		remove_submenu_page( 'index.php', 'index.php' );

		add_menu_page( __( 'My Home', 'jetpack' ), __( 'My Home', 'jetpack' ), 'read', $menu_slug, null, 'dashicons-admin-home', 2 );

		// Only add submenu when there are other submenu items.
		if ( ! empty( $submenu['index.php'] ) ) {
			add_submenu_page( $menu_slug, __( 'My Home', 'jetpack' ), __( 'My Home', 'jetpack' ), 'read', $menu_slug, null, 1 );
		}

		$this->migrate_submenus( 'index.php', $menu_slug );
	}

	/**
	 * Adds Stats menu.
	 */
	public function add_stats_menu() {
		add_menu_page( __( 'Stats', 'jetpack' ), __( 'Stats', 'jetpack' ), 'edit_posts', 'https://wordpress.com/stats/day/' . $this->domain, null, 'dashicons-chart-bar', 3 );
	}

	/**
	 * Adds Upgrades menu.
	 */
	public function add_upgrades_menu() {
		remove_menu_page( 'paid-upgrades.php' );

		$menu_slug = 'https://wordpress.com/plans/' . $this->domain;

		add_menu_page( __( 'Upgrades', 'jetpack' ), __( 'Upgrades', 'jetpack' ), 'manage_options', $menu_slug, null, 'dashicons-cart', 4 );
		add_submenu_page( $menu_slug, __( 'Plans', 'jetpack' ), __( 'Plans', 'jetpack' ), 'manage_options', $menu_slug, null, 5 );
		add_submenu_page( $menu_slug, __( 'Purchases', 'jetpack' ), __( 'Purchases', 'jetpack' ), 'manage_options', 'https://wordpress.com/purchases/subscriptions/' . $this->domain, null, 15 );

		$this->migrate_submenus( 'paid-upgrades.php', $menu_slug );
	}

	/**
	 * Adds Posts menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_posts_menu( $calypso = true ) {
		if ( ! $calypso ) {
			return;
		}

		$ptype_obj = get_post_type_object( 'post' );
		$menu_slug = 'https://wordpress.com/posts/' . $this->domain;

		remove_menu_page( 'edit.php' );
		remove_submenu_page( 'edit.php', 'edit.php' );
		remove_submenu_page( 'edit.php', 'post-new.php' );

		add_menu_page( esc_attr( $ptype_obj->labels->menu_name ), $ptype_obj->labels->menu_name, $ptype_obj->cap->edit_posts, $menu_slug, null, 'dashicons-admin-post', $ptype_obj->menu_position );
		add_submenu_page( $menu_slug, $ptype_obj->labels->all_items, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, $menu_slug, null, 5 );
		add_submenu_page( $menu_slug, $ptype_obj->labels->add_new, $ptype_obj->labels->add_new, $ptype_obj->cap->create_posts, 'https://wordpress.com/post/' . $this->domain, null, 10 );

		$this->migrate_submenus( 'edit.php', $menu_slug );
	}

	/**
	 * Adds Media menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_media_menu( $calypso = true ) {
		remove_submenu_page( 'upload.php', 'upload.php' );
		remove_submenu_page( 'upload.php', 'media-new.php' );

		if ( $calypso ) {
			$menu_slug = 'https://wordpress.com/media/' . $this->domain;

			remove_menu_page( 'upload.php' );
			add_menu_page( __( 'Media', 'jetpack' ), __( 'Media', 'jetpack' ), 'upload_files', $menu_slug, null, 'dashicons-admin-media', 10 );
			$this->migrate_submenus( 'upload.php', $menu_slug );
		}
	}

	/**
	 * Adds Page menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_page_menu( $calypso = true ) {
		if ( ! $calypso ) {
			return;
		}

		$ptype_obj = get_post_type_object( 'page' );
		$menu_slug = 'https://wordpress.com/pages/' . $this->domain;

		remove_menu_page( 'edit.php?post_type=page' );
		remove_submenu_page( 'edit.php?post_type=page', 'edit.php?post_type=page' );
		remove_submenu_page( 'edit.php?post_type=page', 'post-new.php?post_type=page' );

		add_menu_page( esc_attr( $ptype_obj->labels->menu_name ), $ptype_obj->labels->menu_name, $ptype_obj->cap->edit_posts, $menu_slug, null, 'dashicons-admin-page', $ptype_obj->menu_position );
		add_submenu_page( $menu_slug, $ptype_obj->labels->all_items, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, $menu_slug, null, 5 );
		add_submenu_page( $menu_slug, $ptype_obj->labels->add_new, $ptype_obj->labels->add_new, $ptype_obj->cap->create_posts, 'https://wordpress.com/page/' . $this->domain, null, 10 );
		$this->migrate_submenus( 'edit.php?post_type=page', $menu_slug );
	}

	/**
	 * Adds Comments menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_comments_menu( $calypso = true ) {
		if ( ! $calypso || ! current_user_can( 'edit_posts' ) ) {
			return;
		}

		$awaiting_mod      = wp_count_comments();
		$awaiting_mod      = $awaiting_mod->moderated;
		$awaiting_mod_i18n = number_format_i18n( $awaiting_mod );
		/* translators: %s: Number of comments. */
		$awaiting_mod_text = sprintf( _n( '%s Comment in moderation', '%s Comments in moderation', $awaiting_mod, 'jetpack' ), $awaiting_mod_i18n );

		/* translators: %s: Number of comments. */
		$menu_title = sprintf( __( 'Comments %s', 'jetpack' ), '<span class="awaiting-mod count-' . absint( $awaiting_mod ) . '"><span class="pending-count" aria-hidden="true">' . $awaiting_mod_i18n . '</span><span class="comments-in-moderation-text screen-reader-text">' . $awaiting_mod_text . '</span></span>' );
		$menu_slug  = 'https://wordpress.com/comments/all/' . $this->domain;

		remove_menu_page( 'edit-comments.php' );
		remove_submenu_page( 'edit-comments.php', 'edit-comments.php' );

		add_menu_page( esc_attr__( 'Comments', 'jetpack' ), $menu_title, 'edit_posts', $menu_slug, null, 'dashicons-admin-comments', 25 );
		$this->migrate_submenus( 'edit-comments.php', $menu_slug );
	}

	/**
	 * Adds Appearance menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_appearance_menu( $calypso = true ) {
		$user_can_customize = current_user_can( 'customize' );
		$appearance_cap     = $user_can_customize ? 'customize' : 'edit_theme_options';
		$customize_slug     = $calypso ? 'https://wordpress.com/customize/' . $this->domain : 'customize.php';
		$themes_slug        = $calypso ? 'https://wordpress.com/themes/' . $this->domain : 'themes.php';
		$appearance_slug    = $user_can_customize ? $customize_slug : $themes_slug;
		$customize_url      = add_query_arg( 'return', urlencode( remove_query_arg( wp_removable_query_args(), wp_unslash( $_SERVER['REQUEST_URI'] ) ) ), 'customize.php' ); // phpcs:ignore

		remove_menu_page( 'themes.php' );
		remove_submenu_page( 'themes.php', 'themes.php' );
		remove_submenu_page( 'themes.php', 'theme-editor.php' );
		remove_submenu_page( 'themes.php', $customize_url );

		add_menu_page( esc_attr__( 'Appearance', 'jetpack' ), __( 'Appearance', 'jetpack' ), $appearance_cap, $appearance_slug, null, 'dashicons-admin-appearance', 60 );
		add_submenu_page( $appearance_slug, esc_attr__( 'Customize', 'jetpack' ), __( 'Customize', 'jetpack' ), 'customize', $customize_slug, null, 5 );
		add_submenu_page( $appearance_slug, esc_attr__( 'Themes', 'jetpack' ), __( 'Themes', 'jetpack' ), 'switch_themes', $themes_slug, null, 10 );

		if ( current_theme_supports( 'custom-header' ) && $user_can_customize ) {
			$customize_header_url = add_query_arg( array( 'autofocus' => array( 'control' => 'header_image' ) ), $customize_url );
			remove_submenu_page( 'themes.php', $customize_header_url );

			$customize_header_url = add_query_arg( array( 'autofocus' => array( 'control' => 'header_image' ) ), $appearance_slug );
			add_submenu_page( $appearance_slug, __( 'Header', 'jetpack' ), __( 'Header', 'jetpack' ), $appearance_cap, esc_url( $customize_header_url ), null, 15 );
		}

		if ( current_theme_supports( 'custom-background' ) && $user_can_customize ) {
			$customize_background_url = add_query_arg( array( 'autofocus' => array( 'control' => 'background_image' ) ), $customize_url );
			remove_submenu_page( 'themes.php', $customize_background_url );

			$customize_background_url = add_query_arg( array( 'autofocus' => array( 'control' => 'background_image' ) ), $appearance_slug );
			add_submenu_page( $appearance_slug, esc_attr__( 'Background', 'jetpack' ), __( 'Background', 'jetpack' ), $appearance_cap, esc_url( $customize_background_url ), null, 20 );
		}

		if ( current_theme_supports( 'widgets' ) ) {
			remove_submenu_page( 'themes.php', 'widgets.php' );

			$customize_menu_url = add_query_arg( array( 'autofocus' => array( 'panel' => 'widgets' ) ), $appearance_slug );
			add_submenu_page( $appearance_slug, esc_attr__( 'Widgets', 'jetpack' ), __( 'Widgets', 'jetpack' ), $appearance_cap, esc_url( $customize_menu_url ), null, 20 );
		}

		if ( current_theme_supports( 'menus' ) || current_theme_supports( 'widgets' ) ) {
			remove_submenu_page( 'themes.php', 'nav-menus.php' );

			$customize_menu_url = add_query_arg( array( 'autofocus' => array( 'panel' => 'nav_menus' ) ), $appearance_slug );
			add_submenu_page( $appearance_slug, esc_attr__( 'Menus', 'jetpack' ), __( 'Menus', 'jetpack' ), $appearance_cap, esc_url( $customize_menu_url ), null, 20 );
		}

		$this->migrate_submenus( 'themes.php', $appearance_slug );
	}

	/**
	 * Adds Plugins menu.
	 */
	public function add_plugins_menu() {
		remove_submenu_page( 'plugins.php', 'plugin-editor.php' );
	}

	/**
	 * Adds Users menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_users_menu( $calypso = true ) {
		$users_slug   = $calypso ? 'https://wordpress.com/people/team/' . $this->domain : 'users.php';
		$add_new_slug = 'https://wordpress.com/people/new/' . $this->domain;
		$profile_slug = $calypso ? 'https://wordpress.com/me' : 'profile.php';

		if ( current_user_can( 'list_users' ) ) {
			remove_menu_page( 'users.php' );
			remove_submenu_page( 'users.php', 'users.php' );
			remove_submenu_page( 'users.php', 'user-new.php' );
			remove_submenu_page( 'users.php', 'profile.php' );
			remove_submenu_page( 'users.php', 'grofiles-editor' );
			remove_submenu_page( 'users.php', 'grofiles-user-settings' );

			add_menu_page( esc_attr__( 'Users', 'jetpack' ), __( 'Users', 'jetpack' ), 'list_users', $users_slug, null, 'dashicons-admin-users', 70 );
			add_submenu_page( $users_slug, esc_attr__( 'All People', 'jetpack' ), __( 'All People', 'jetpack' ), 'list_users', $users_slug, null, 5 );
			add_submenu_page( $users_slug, esc_attr__( 'Add New', 'jetpack' ), __( 'Add New', 'jetpack' ), 'promote_users', $add_new_slug, null, 10 );
			add_submenu_page( $users_slug, esc_attr__( 'My Profile', 'jetpack' ), __( 'My Profile', 'jetpack' ), 'read', $profile_slug, null, 15 );
			add_submenu_page( $users_slug, esc_attr__( 'Account Settings', 'jetpack' ), __( 'Account Settings', 'jetpack' ), 'read', 'https://wordpress.com/me/account', null, 20 );
			$this->migrate_submenus( 'users.php', $users_slug );
		}
	}

	/**
	 * Adds Tools menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_tools_menu( $calypso = true ) {
		if ( ! $calypso ) {
			return;
		}

		$admin_slug = 'tools.php';
		$menu_slug  = 'https://wordpress.com/marketing/tools/' . $this->domain;

		remove_menu_page( $admin_slug );
		remove_submenu_page( $admin_slug, $admin_slug );
		remove_submenu_page( $admin_slug, 'import.php' );
		remove_submenu_page( $admin_slug, 'export.php' );
		remove_submenu_page( $admin_slug, 'delete-blog' );

		add_menu_page( esc_attr__( 'Tools', 'jetpack' ), __( 'Tools', 'jetpack' ), 'manage_options', $menu_slug, null, 'dashicons-admin-tools', 75 );
		add_submenu_page( $menu_slug, esc_attr__( 'Import', 'jetpack' ), __( 'Import', 'jetpack' ), 'import', 'https://wordpress.com/import/' . $this->domain, null, 15 );
		add_submenu_page( $menu_slug, esc_attr__( 'Export', 'jetpack' ), __( 'Export', 'jetpack' ), 'export', 'https://wordpress.com/export/' . $this->domain, null, 20 );

		$this->migrate_submenus( $admin_slug, $menu_slug );

	}

	/**
	 * Adds Settings menu.
	 *
	 * @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
	 */
	public function add_options_menu( $calypso = true ) {
		if ( $calypso ) {
			remove_submenu_page( 'options-general.php', 'options-discussion.php' );
			remove_submenu_page( 'options-general.php', 'options-writing.php' );
		}
	}

	/**
	 * Migrates submenu items from wp-admin menu slugs to Calypso menu slugs.
	 *
	 * @param string $old_slug WP-Admin menu slug.
	 * @param string $new_slug Calypso menu slug. (Calypso URL).
	 */
	public function migrate_submenus( $old_slug, $new_slug ) {
		global $submenu;

		if ( $old_slug !== $new_slug && ! empty( $submenu[ $old_slug ] ) ) {
			if ( ! empty( $submenu[ $new_slug ] ) ) {
				// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
				$submenu[ $new_slug ] = array_replace( $submenu[ $new_slug ], $submenu[ $old_slug ] );
			} else {
				// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
				$submenu[ $new_slug ] = $submenu[ $old_slug ];
			}
			unset( $submenu[ $old_slug ] );
		}
	}

	/**
	 * Adds a menu separator.
	 *
	 * @param int    $position The position in the menu order this item should appear.
	 * @param string $cap      Optional. The capability required for this menu to be displayed to the user.
	 *                         Default: 'read'.
	 */
	public function add_admin_menu_separator( $position, $cap = 'read' ) {
		global $menu;
		static $uid = 3;

		// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
		$menu[ $position ] = array(
			'',                               // Menu title (ignored).
			$cap,                             // Required capability.
			'separator-custom-' . ( ++$uid ), // URL or file (ignored, but must be unique).
			'',                               // Page title (ignored).
			'wp-menu-separator',              // CSS class. Identifies this item as a separator.
		);
		ksort( $menu );
	}

	/**
	 * Enqueues scripts and styles.
	 */
	public function enqueue_scripts() {
		$style_dependencies = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$rtl                = is_rtl() ? '-rtl' : '';
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
			$style_dependencies = array( 'wpcom-admin-bar', 'wpcom-masterbar-css' );
		} else {
			$style_dependencies = array( 'a8c-wpcom-masterbar' . $rtl, 'a8c-wpcom-masterbar-overrides' . $rtl );
		}
		wp_enqueue_style(
			'jetpack-admin-menu',
			plugins_url( 'admin-menu.css', __FILE__ ),
			$style_dependencies,
			JETPACK__VERSION
		);
		wp_enqueue_script(
			'jetpack-admin-menu',
			plugins_url( 'admin-menu.js', __FILE__ ),
			array(),
			JETPACK__VERSION,
			true
		);
	}

	/**
	 * Dequeues unnecessary scripts.
	 */
	public function dequeue_scripts() {
		wp_dequeue_script( 'a8c_wpcom_masterbar_overrides' ); // Initially loaded in modules/masterbar/masterbar/class-masterbar.php.
	}
}


1		<?php
2		/**
3		* Admin Menu file.
4		*
5		* @package Jetpack
6		*/
7
8		namespace Automattic\Jetpack\Dashboard_Customizations;
9
10		use Automattic\Jetpack\Status;
11
12		/**
13		* Class Admin_Menu.
14		*/
15		class Admin_Menu {
16		/**
17		* Holds class instances.
18		*
19		* @var array
20		*/
21		protected static $instances;
22
23		/**
24		* Whether the current request is a REST API request.
25		*
26		* @var bool
27		*/
28		protected $is_api_request = false;
29
30		/**
31		* Domain of the current site.
32		*
33		* @var string
34		*/
35		protected $domain;
36
37		/**
38		* Admin_Menu constructor.
39		*/
40		protected function __construct() {
41		add_action( 'admin_menu', array( $this, 'reregister_menu_items' ), 99999 );
42		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
43		add_action( 'wp_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );
44		add_action( 'admin_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );
45		add_action( 'rest_request_before_callbacks', array( $this, 'rest_api_init' ), 11 );
46
47		$this->domain = ( new Status() )->get_site_suffix();
48		}
49
50		/**
51		* Returns class instance.
52		*
53		* @return Admin_Menu
54		*/
55		public static function get_instance() {
56		$class = get_called_class();
57
58		if ( empty( static::$instances[ $class ] ) ) {
59		static::$instances[ $class ] = new $class();
60		}
61
62		return static::$instances[ $class ];
63		}
64
65		/**
66		* Sets up class properties for REST API requests.
67		*/
68		public function rest_api_init() {
69		$this->is_api_request = true;
70		}
71
72		/**
73		* Create the desired menu output.
74		*/
75		public function reregister_menu_items() {
76		// Constant is not defined until parse_request.
77		if ( ! $this->is_api_request ) {
78		$this->is_api_request = defined( 'REST_REQUEST' ) && REST_REQUEST;
79		}
80
81		/**
82		* Whether links should point to Calypso or wp-admin.
83		*
84		* Options:
85		* true - Calypso.
86		* false - wp-admin.
87		*
88		* @module masterbar
89		* @since 9.3.0
90		*
91		* @param bool $calypso Whether menu item URLs should point to Calypso.
92		*/
93		$calypso = apply_filters( 'jetpack_admin_menu_use_calypso_links', true );
94
95		// Remove separators.
96		remove_menu_page( 'separator1' );
97
98		$this->add_my_home_menu( $calypso );
99		$this->add_stats_menu();
100		$this->add_upgrades_menu();
101		$this->add_posts_menu( $calypso );
102		$this->add_media_menu( $calypso );
103		$this->add_page_menu( $calypso );
104		$this->add_comments_menu( $calypso );
105		$this->add_appearance_menu( $calypso );
106		$this->add_plugins_menu();
107		$this->add_users_menu( $calypso );
108		$this->add_tools_menu( $calypso );
109		$this->add_options_menu();
110
111		ksort( $GLOBALS['menu'] );
112		}
113
114		/**
115		* Adds My Home menu.
116		*
117		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
118		*/
119		public function add_my_home_menu( $calypso = true ) {
120		global $submenu;
121
122		$menu_slug = $calypso ? 'https://wordpress.com/home/' . $this->domain : 'index.php';
123
124		remove_menu_page( 'index.php' );
125		remove_submenu_page( 'index.php', 'index.php' );
126
127		add_menu_page( __( 'My Home', 'jetpack' ), __( 'My Home', 'jetpack' ), 'read', $menu_slug, null, 'dashicons-admin-home', 2 );
128
129		// Only add submenu when there are other submenu items.
130		if ( ! empty( $submenu['index.php'] ) ) {
131		add_submenu_page( $menu_slug, __( 'My Home', 'jetpack' ), __( 'My Home', 'jetpack' ), 'read', $menu_slug, null, 1 );
132		}
133
134		$this->migrate_submenus( 'index.php', $menu_slug );
135		}
136
137		/**
138		* Adds Stats menu.
139		*/
140		public function add_stats_menu() {
141		add_menu_page( __( 'Stats', 'jetpack' ), __( 'Stats', 'jetpack' ), 'edit_posts', 'https://wordpress.com/stats/day/' . $this->domain, null, 'dashicons-chart-bar', 3 );
142		}
143
144		/**
145		* Adds Upgrades menu.
146		*/
147		public function add_upgrades_menu() {
148		remove_menu_page( 'paid-upgrades.php' );
149
150		$menu_slug = 'https://wordpress.com/plans/' . $this->domain;
151
152		add_menu_page( __( 'Upgrades', 'jetpack' ), __( 'Upgrades', 'jetpack' ), 'manage_options', $menu_slug, null, 'dashicons-cart', 4 );
153		add_submenu_page( $menu_slug, __( 'Plans', 'jetpack' ), __( 'Plans', 'jetpack' ), 'manage_options', $menu_slug, null, 5 );
154		add_submenu_page( $menu_slug, __( 'Purchases', 'jetpack' ), __( 'Purchases', 'jetpack' ), 'manage_options', 'https://wordpress.com/purchases/subscriptions/' . $this->domain, null, 15 );
155
156		$this->migrate_submenus( 'paid-upgrades.php', $menu_slug );
157		}
158
159		/**
160		* Adds Posts menu.
161		*
162		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
163		*/
164	View Code Duplication	public function add_posts_menu( $calypso = true ) {
165		if ( ! $calypso ) {
166		return;
167		}
168
169		$ptype_obj = get_post_type_object( 'post' );
170		$menu_slug = 'https://wordpress.com/posts/' . $this->domain;
171
172		remove_menu_page( 'edit.php' );
173		remove_submenu_page( 'edit.php', 'edit.php' );
174		remove_submenu_page( 'edit.php', 'post-new.php' );
175
176		add_menu_page( esc_attr( $ptype_obj->labels->menu_name ), $ptype_obj->labels->menu_name, $ptype_obj->cap->edit_posts, $menu_slug, null, 'dashicons-admin-post', $ptype_obj->menu_position );
177		add_submenu_page( $menu_slug, $ptype_obj->labels->all_items, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, $menu_slug, null, 5 );
178		add_submenu_page( $menu_slug, $ptype_obj->labels->add_new, $ptype_obj->labels->add_new, $ptype_obj->cap->create_posts, 'https://wordpress.com/post/' . $this->domain, null, 10 );
179
180		$this->migrate_submenus( 'edit.php', $menu_slug );
181		}
182
183		/**
184		* Adds Media menu.
185		*
186		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
187		*/
188		public function add_media_menu( $calypso = true ) {
189		remove_submenu_page( 'upload.php', 'upload.php' );
190		remove_submenu_page( 'upload.php', 'media-new.php' );
191
192		if ( $calypso ) {
193		$menu_slug = 'https://wordpress.com/media/' . $this->domain;
194
195		remove_menu_page( 'upload.php' );
196		add_menu_page( __( 'Media', 'jetpack' ), __( 'Media', 'jetpack' ), 'upload_files', $menu_slug, null, 'dashicons-admin-media', 10 );
197		$this->migrate_submenus( 'upload.php', $menu_slug );
198		}
199		}
200
201		/**
202		* Adds Page menu.
203		*
204		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
205		*/
206	View Code Duplication	public function add_page_menu( $calypso = true ) {
207		if ( ! $calypso ) {
208		return;
209		}
210
211		$ptype_obj = get_post_type_object( 'page' );
212		$menu_slug = 'https://wordpress.com/pages/' . $this->domain;
213
214		remove_menu_page( 'edit.php?post_type=page' );
215		remove_submenu_page( 'edit.php?post_type=page', 'edit.php?post_type=page' );
216		remove_submenu_page( 'edit.php?post_type=page', 'post-new.php?post_type=page' );
217
218		add_menu_page( esc_attr( $ptype_obj->labels->menu_name ), $ptype_obj->labels->menu_name, $ptype_obj->cap->edit_posts, $menu_slug, null, 'dashicons-admin-page', $ptype_obj->menu_position );
219		add_submenu_page( $menu_slug, $ptype_obj->labels->all_items, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, $menu_slug, null, 5 );
220		add_submenu_page( $menu_slug, $ptype_obj->labels->add_new, $ptype_obj->labels->add_new, $ptype_obj->cap->create_posts, 'https://wordpress.com/page/' . $this->domain, null, 10 );
221		$this->migrate_submenus( 'edit.php?post_type=page', $menu_slug );
222		}
223
224		/**
225		* Adds Comments menu.
226		*
227		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
228		*/
229		public function add_comments_menu( $calypso = true ) {
230		if ( ! $calypso \|\| ! current_user_can( 'edit_posts' ) ) {
231		return;
232		}
233
234		$awaiting_mod = wp_count_comments();
235		$awaiting_mod = $awaiting_mod->moderated;
236		$awaiting_mod_i18n = number_format_i18n( $awaiting_mod );
237		/* translators: %s: Number of comments. */
238		$awaiting_mod_text = sprintf( _n( '%s Comment in moderation', '%s Comments in moderation', $awaiting_mod, 'jetpack' ), $awaiting_mod_i18n );
239
240		/* translators: %s: Number of comments. */
241		$menu_title = sprintf( __( 'Comments %s', 'jetpack' ), '<span class="awaiting-mod count-' . absint( $awaiting_mod ) . '"><span class="pending-count" aria-hidden="true">' . $awaiting_mod_i18n . '</span><span class="comments-in-moderation-text screen-reader-text">' . $awaiting_mod_text . '</span></span>' );
242		$menu_slug = 'https://wordpress.com/comments/all/' . $this->domain;
243
244		remove_menu_page( 'edit-comments.php' );
245		remove_submenu_page( 'edit-comments.php', 'edit-comments.php' );
246
247		add_menu_page( esc_attr__( 'Comments', 'jetpack' ), $menu_title, 'edit_posts', $menu_slug, null, 'dashicons-admin-comments', 25 );
248		$this->migrate_submenus( 'edit-comments.php', $menu_slug );
249		}
250
251		/**
252		* Adds Appearance menu.
253		*
254		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
255		*/
256		public function add_appearance_menu( $calypso = true ) {
257		$user_can_customize = current_user_can( 'customize' );
258		$appearance_cap = $user_can_customize ? 'customize' : 'edit_theme_options';
259		$customize_slug = $calypso ? 'https://wordpress.com/customize/' . $this->domain : 'customize.php';
260		$themes_slug = $calypso ? 'https://wordpress.com/themes/' . $this->domain : 'themes.php';
261		$appearance_slug = $user_can_customize ? $customize_slug : $themes_slug;
262		$customize_url = add_query_arg( 'return', urlencode( remove_query_arg( wp_removable_query_args(), wp_unslash( $_SERVER['REQUEST_URI'] ) ) ), 'customize.php' ); // phpcs:ignore
263
264		remove_menu_page( 'themes.php' );
265		remove_submenu_page( 'themes.php', 'themes.php' );
266		remove_submenu_page( 'themes.php', 'theme-editor.php' );
267		remove_submenu_page( 'themes.php', $customize_url );
268
269		add_menu_page( esc_attr__( 'Appearance', 'jetpack' ), __( 'Appearance', 'jetpack' ), $appearance_cap, $appearance_slug, null, 'dashicons-admin-appearance', 60 );
270		add_submenu_page( $appearance_slug, esc_attr__( 'Customize', 'jetpack' ), __( 'Customize', 'jetpack' ), 'customize', $customize_slug, null, 5 );
271		add_submenu_page( $appearance_slug, esc_attr__( 'Themes', 'jetpack' ), __( 'Themes', 'jetpack' ), 'switch_themes', $themes_slug, null, 10 );
272
273	View Code Duplication	if ( current_theme_supports( 'custom-header' ) && $user_can_customize ) {
274		$customize_header_url = add_query_arg( array( 'autofocus' => array( 'control' => 'header_image' ) ), $customize_url );
275		remove_submenu_page( 'themes.php', $customize_header_url );
276
277		$customize_header_url = add_query_arg( array( 'autofocus' => array( 'control' => 'header_image' ) ), $appearance_slug );
278		add_submenu_page( $appearance_slug, __( 'Header', 'jetpack' ), __( 'Header', 'jetpack' ), $appearance_cap, esc_url( $customize_header_url ), null, 15 );
279		}
280
281	View Code Duplication	if ( current_theme_supports( 'custom-background' ) && $user_can_customize ) {
282		$customize_background_url = add_query_arg( array( 'autofocus' => array( 'control' => 'background_image' ) ), $customize_url );
283		remove_submenu_page( 'themes.php', $customize_background_url );
284
285		$customize_background_url = add_query_arg( array( 'autofocus' => array( 'control' => 'background_image' ) ), $appearance_slug );
286		add_submenu_page( $appearance_slug, esc_attr__( 'Background', 'jetpack' ), __( 'Background', 'jetpack' ), $appearance_cap, esc_url( $customize_background_url ), null, 20 );
287		}
288
289	View Code Duplication	if ( current_theme_supports( 'widgets' ) ) {
290		remove_submenu_page( 'themes.php', 'widgets.php' );
291
292		$customize_menu_url = add_query_arg( array( 'autofocus' => array( 'panel' => 'widgets' ) ), $appearance_slug );
293		add_submenu_page( $appearance_slug, esc_attr__( 'Widgets', 'jetpack' ), __( 'Widgets', 'jetpack' ), $appearance_cap, esc_url( $customize_menu_url ), null, 20 );
294		}
295
296	View Code Duplication	if ( current_theme_supports( 'menus' ) \|\| current_theme_supports( 'widgets' ) ) {
297		remove_submenu_page( 'themes.php', 'nav-menus.php' );
298
299		$customize_menu_url = add_query_arg( array( 'autofocus' => array( 'panel' => 'nav_menus' ) ), $appearance_slug );
300		add_submenu_page( $appearance_slug, esc_attr__( 'Menus', 'jetpack' ), __( 'Menus', 'jetpack' ), $appearance_cap, esc_url( $customize_menu_url ), null, 20 );
301		}
302
303		$this->migrate_submenus( 'themes.php', $appearance_slug );
304		}
305
306		/**
307		* Adds Plugins menu.
308		*/
309		public function add_plugins_menu() {
310		remove_submenu_page( 'plugins.php', 'plugin-editor.php' );
311		}
312
313		/**
314		* Adds Users menu.
315		*
316		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
317		*/
318		public function add_users_menu( $calypso = true ) {
319		$users_slug = $calypso ? 'https://wordpress.com/people/team/' . $this->domain : 'users.php';
320		$add_new_slug = 'https://wordpress.com/people/new/' . $this->domain;
321		$profile_slug = $calypso ? 'https://wordpress.com/me' : 'profile.php';
322
323		if ( current_user_can( 'list_users' ) ) {
324		remove_menu_page( 'users.php' );
325		remove_submenu_page( 'users.php', 'users.php' );
326		remove_submenu_page( 'users.php', 'user-new.php' );
327		remove_submenu_page( 'users.php', 'profile.php' );
328		remove_submenu_page( 'users.php', 'grofiles-editor' );
329		remove_submenu_page( 'users.php', 'grofiles-user-settings' );
330
331		add_menu_page( esc_attr__( 'Users', 'jetpack' ), __( 'Users', 'jetpack' ), 'list_users', $users_slug, null, 'dashicons-admin-users', 70 );
332		add_submenu_page( $users_slug, esc_attr__( 'All People', 'jetpack' ), __( 'All People', 'jetpack' ), 'list_users', $users_slug, null, 5 );
333		add_submenu_page( $users_slug, esc_attr__( 'Add New', 'jetpack' ), __( 'Add New', 'jetpack' ), 'promote_users', $add_new_slug, null, 10 );
334		add_submenu_page( $users_slug, esc_attr__( 'My Profile', 'jetpack' ), __( 'My Profile', 'jetpack' ), 'read', $profile_slug, null, 15 );
335		add_submenu_page( $users_slug, esc_attr__( 'Account Settings', 'jetpack' ), __( 'Account Settings', 'jetpack' ), 'read', 'https://wordpress.com/me/account', null, 20 );
336		$this->migrate_submenus( 'users.php', $users_slug );
337		}
338		}
339
340		/**
341		* Adds Tools menu.
342		*
343		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
344		*/
345		public function add_tools_menu( $calypso = true ) {
346		if ( ! $calypso ) {
347		return;
348		}
349
350		$admin_slug = 'tools.php';
351		$menu_slug = 'https://wordpress.com/marketing/tools/' . $this->domain;
352
353		remove_menu_page( $admin_slug );
354		remove_submenu_page( $admin_slug, $admin_slug );
355		remove_submenu_page( $admin_slug, 'import.php' );
356		remove_submenu_page( $admin_slug, 'export.php' );
357		remove_submenu_page( $admin_slug, 'delete-blog' );
358
359		add_menu_page( esc_attr__( 'Tools', 'jetpack' ), __( 'Tools', 'jetpack' ), 'manage_options', $menu_slug, null, 'dashicons-admin-tools', 75 );
360		add_submenu_page( $menu_slug, esc_attr__( 'Import', 'jetpack' ), __( 'Import', 'jetpack' ), 'import', 'https://wordpress.com/import/' . $this->domain, null, 15 );
361		add_submenu_page( $menu_slug, esc_attr__( 'Export', 'jetpack' ), __( 'Export', 'jetpack' ), 'export', 'https://wordpress.com/export/' . $this->domain, null, 20 );
362
363		$this->migrate_submenus( $admin_slug, $menu_slug );
364
365		}
366
367		/**
368		* Adds Settings menu.
369		*
370		* @param bool $calypso Optional. Whether links should point to Calypso or wp-admin. Default true (Calypso).
371		*/
372		public function add_options_menu( $calypso = true ) {
373		if ( $calypso ) {
374		remove_submenu_page( 'options-general.php', 'options-discussion.php' );
375		remove_submenu_page( 'options-general.php', 'options-writing.php' );
376		}
377		}
378
379		/**
380		* Migrates submenu items from wp-admin menu slugs to Calypso menu slugs.
381		*
382		* @param string $old_slug WP-Admin menu slug.
383		* @param string $new_slug Calypso menu slug. (Calypso URL).
384		*/
385		public function migrate_submenus( $old_slug, $new_slug ) {
386		global $submenu;
387
388		if ( $old_slug !== $new_slug && ! empty( $submenu[ $old_slug ] ) ) {
389		if ( ! empty( $submenu[ $new_slug ] ) ) {
390		// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
391		$submenu[ $new_slug ] = array_replace( $submenu[ $new_slug ], $submenu[ $old_slug ] );
392		} else {
393		// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
394		$submenu[ $new_slug ] = $submenu[ $old_slug ];
395		}
396		unset( $submenu[ $old_slug ] );
397		}
398		}
399
400		/**
401		* Adds a menu separator.
402		*
403		* @param int $position The position in the menu order this item should appear.
404		* @param string $cap Optional. The capability required for this menu to be displayed to the user.
405		* Default: 'read'.
406		*/
407		public function add_admin_menu_separator( $position, $cap = 'read' ) {
408		global $menu;
409		static $uid = 3;
410
411		// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
412		$menu[ $position ] = array(
413		'', // Menu title (ignored).
414		$cap, // Required capability.
415		'separator-custom-' . ( ++$uid ), // URL or file (ignored, but must be unique).
416		'', // Page title (ignored).
417		'wp-menu-separator', // CSS class. Identifies this item as a separator.
418		);
419		ksort( $menu );
420		}
421
422		/**
423		* Enqueues scripts and styles.
424		*/
425		public function enqueue_scripts() {
426		$style_dependencies = array();
		0 ignored issues – show Unused Code introduced 2020-12-21 09:48 UTC by Report Bug Copy Issue Report `$style_dependencies` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
427		$rtl = is_rtl() ? '-rtl' : '';
428	View Code Duplication	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
429		$style_dependencies = array( 'wpcom-admin-bar', 'wpcom-masterbar-css' );
430		} else {
431		$style_dependencies = array( 'a8c-wpcom-masterbar' . $rtl, 'a8c-wpcom-masterbar-overrides' . $rtl );
432		}
433		wp_enqueue_style(
434		'jetpack-admin-menu',
435		plugins_url( 'admin-menu.css', __FILE__ ),
436		$style_dependencies,
437		JETPACK__VERSION
438		);
439		wp_enqueue_script(
440		'jetpack-admin-menu',
441		plugins_url( 'admin-menu.js', __FILE__ ),
442		array(),
443		JETPACK__VERSION,
444		true
445		);
446		}
447
448		/**
449		* Dequeues unnecessary scripts.
450		*/
451		public function dequeue_scripts() {
452		wp_dequeue_script( 'a8c_wpcom_masterbar_overrides' ); // Initially loaded in modules/masterbar/masterbar/class-masterbar.php.
453		}
454		}
455

Automattic / jetpack