Jetpack_Admin_Menu::add_jetpack_menu() - Code Metrics - Inspection of "Admin Menu: Mimic existing Calypso menu on Jetpack..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/admin-menu-jetpack-site... ( 93812c )

unknown

created 2021-02-24 16:23 UTC

Jetpack_Admin_Menu::add_jetpack_menu() A

↳ Parent: Jetpack_Admin_Menu

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	0
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0

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

namespace Automattic\Jetpack\Dashboard_Customizations;

require_once __DIR__ . '/class-admin-menu.php';

/**
 * Class Jetpack_Admin_Menu.
 */
class Jetpack_Admin_Menu extends Admin_Menu {

	/**
	 * Create the desired menu output.
	 */
	public function reregister_menu_items() {
		global $menu, $submenu;

		if ( $this->is_api_request || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) {
			// Reset menus for API requests (i.e. Calypso) so there are no third-party plugin items.
			$menu    = array(); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
			$submenu = array(); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
		}

		parent::reregister_menu_items();

		$this->add_wp_admin_menu();

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

	/**
	 * Adds Jetpack menu.
	 */
	public function add_jetpack_menu() {
		parent::add_jetpack_menu();

		$parent_slug = 'https://wordpress.com/activity-log/' . $this->domain;

		// Place "Scan" submenu after Backup.
		$position = 0;
		global $submenu;
		foreach ( $submenu[ $parent_slug ] as $submenu_item ) {
			$position++;
			if ( __( 'Backup', 'jetpack' ) === $submenu_item[3] ) {
				break;
			}
		}
		add_submenu_page( $parent_slug, esc_attr__( 'Scan', 'jetpack' ), __( 'Scan', 'jetpack' ), 'manage_options', 'https://wordpress.com/scan/' . $this->domain, null, $position );
	}

	/**
	 * Adds Tools menu.
	 *
	 * @param bool $wp_admin_import Optional. Whether Import link should point to Calypso or wp-admin. Default false (Calypso).
	 * @param bool $wp_admin_export Optional. Whether Export link should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_tools_menu( $wp_admin_import = false, $wp_admin_export = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		$admin_slug = 'tools.php';
		$menu_slug  = 'https://wordpress.com/marketing/tools/' . $this->domain;

		remove_menu_page( $admin_slug );
		$this->remove_submenus( $admin_slug );

		add_menu_page( esc_attr__( 'Tools', 'jetpack' ), __( 'Tools', 'jetpack' ), 'publish_posts', $menu_slug, null, 'dashicons-admin-tools', 75 );
		add_submenu_page( $menu_slug, esc_attr__( 'Marketing', 'jetpack' ), __( 'Marketing', 'jetpack' ), 'publish_posts', $menu_slug );
		add_submenu_page( $menu_slug, esc_attr__( 'Earn', 'jetpack' ), __( 'Earn', 'jetpack' ), 'manage_options', 'https://wordpress.com/earn/' . $this->domain );

		// Import/Export on Jetpack sites is always handled on WP Admin.
		add_submenu_page( $menu_slug, esc_attr__( 'Import', 'jetpack' ), __( 'Import', 'jetpack' ), 'import', 'import.php' );
		add_submenu_page( $menu_slug, esc_attr__( 'Export', 'jetpack' ), __( 'Export', 'jetpack' ), 'export', 'export.php' );

	}

	/**
	 * Adds WP Admin menu.
	 */
	public function add_wp_admin_menu() {
		global $menu;
		$menu_slug = 'index.php';

		remove_menu_page( $menu_slug );
		$this->remove_submenus( $menu_slug );

		// Attempt to get last position.
		ksort( $menu );
		end( $menu );
		$position = key( $menu );

		$this->add_admin_menu_separator( ++$position );

		add_menu_page( __( 'WP Admin', 'jetpack' ), __( 'WP Admin', 'jetpack' ), 'read', $menu_slug, null, 'dashicons-wordpress-alt', $position );
	}

	/**
	 * Adds Appearance menu.
	 *
	 * @param bool $wp_admin_themes Optional. Whether Themes link should point to Calypso or wp-admin. Default false (Calypso).
	 * @param bool $wp_admin_customize Optional. Whether Customize link should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_appearance_menu( $wp_admin_themes = false, $wp_admin_customize = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		$appearance_cap = current_user_can( 'switch_themes' ) ? 'switch_themes' : 'edit_theme_options';
		$admin_slug     = 'themes.php';
		$menu_slug      = 'https://wordpress.com/themes/' . $this->domain;

		// Remove all submenus except Themes and Customize to mimic the old Calypso navigation.
		remove_menu_page( $admin_slug );
		$this->remove_submenus( $admin_slug );
		add_menu_page( esc_attr__( 'Appearance', 'jetpack' ), __( 'Appearance', 'jetpack' ), $appearance_cap, $menu_slug, null, 'dashicons-admin-appearance', 60 );
		add_submenu_page( $menu_slug, esc_attr__( 'Themes', 'jetpack' ), __( 'Themes', 'jetpack' ), 'switch_themes', $menu_slug );

		// Customize on Jetpack sites is always done on WP Admin (unsupported by Calypso).
		add_submenu_page( $menu_slug, esc_attr__( 'Customize', 'jetpack' ), __( 'Customize', 'jetpack' ), 'customize', 'customize.php' );
	}

	/**
	 * Adds Posts menu.
	 *
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_posts_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		parent::add_posts_menu();

		// Remove all submenus to mimic the old Calypso navigation.
		$this->remove_submenus( 'https://wordpress.com/posts/' . $this->domain );
	}

	/**
	 * Adds Page menu.
	 *
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_page_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		parent::add_page_menu();

		// Remove all submenus to mimic the old Calypso navigation.
		$this->remove_submenus( 'https://wordpress.com/pages/' . $this->domain );
	}

	/**
	 * Adds a custom post type menu.
	 *
	 * @param string $post_type Custom post type.
	 * @param bool   $wp_admin  Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_custom_post_type_menu( $post_type, $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		parent::add_custom_post_type_menu( $post_type );

		// Remove all submenus to mimic the old Calypso navigation.
		$this->remove_submenus( 'https://wordpress.com/types/' . $post_type . '/' . $this->domain );
	}

	/**
	 * Adds Users menu.
	 *
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_users_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		parent::add_users_menu();

		// Remove all submenus to mimic the old Calypso navigation.
		$this->remove_submenus( 'https://wordpress.com/people/team/' . $this->domain );
	}

	/**
	 * Whether to use wp-admin pages rather than Calypso.
	 *
	 * @return bool
	 */
	public function should_link_to_wp_admin() {
		// Force Calypso links on Jetpack sites since Nav Unification is disabled on WP Admin.
		return false;
	}

	/**
	 * 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 ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		// Do not migrate menu on Jetpack sites, since we don't want WP Admin links.
		// Instead we remove the submenu since they won't be used.
		$this->remove_submenus( $old_slug );
	}
}


1			<?php
2			/**
3			* Jetpack Admin Menu file.
4			*
5			* @package Jetpack
6			*/
7
8			namespace Automattic\Jetpack\Dashboard_Customizations;
9
10			require_once __DIR__ . '/class-admin-menu.php';
11
12			/**
13			* Class Jetpack_Admin_Menu.
14			*/
15			class Jetpack_Admin_Menu extends Admin_Menu {
16
17			/**
18			* Create the desired menu output.
19			*/
20			public function reregister_menu_items() {
21			global $menu, $submenu;
22
23			if ( $this->is_api_request \|\| ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) {
24			// Reset menus for API requests (i.e. Calypso) so there are no third-party plugin items.
25			$menu = array(); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
26			$submenu = array(); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
27			}
28
29			parent::reregister_menu_items();
30
31			$this->add_wp_admin_menu();
32
33			ksort( $GLOBALS['menu'] );
34			}
35
36			/**
37			* Adds Jetpack menu.
38			*/
39			public function add_jetpack_menu() {
40			parent::add_jetpack_menu();
41
42			$parent_slug = 'https://wordpress.com/activity-log/' . $this->domain;
43
44			// Place "Scan" submenu after Backup.
45			$position = 0;
46			global $submenu;
47			foreach ( $submenu[ $parent_slug ] as $submenu_item ) {
48			$position++;
49			if ( __( 'Backup', 'jetpack' ) === $submenu_item[3] ) {
50			break;
51			}
52			}
53			add_submenu_page( $parent_slug, esc_attr__( 'Scan', 'jetpack' ), __( 'Scan', 'jetpack' ), 'manage_options', 'https://wordpress.com/scan/' . $this->domain, null, $position );
54			}
55
56			/**
57			* Adds Tools menu.
58			*
59			* @param bool $wp_admin_import Optional. Whether Import link should point to Calypso or wp-admin. Default false (Calypso).
60			* @param bool $wp_admin_export Optional. Whether Export link should point to Calypso or wp-admin. Default false (Calypso).
61			*/
62			public function add_tools_menu( $wp_admin_import = false, $wp_admin_export = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
63			$admin_slug = 'tools.php';
64			$menu_slug = 'https://wordpress.com/marketing/tools/' . $this->domain;
65
66			remove_menu_page( $admin_slug );
67			$this->remove_submenus( $admin_slug );
68
69			add_menu_page( esc_attr__( 'Tools', 'jetpack' ), __( 'Tools', 'jetpack' ), 'publish_posts', $menu_slug, null, 'dashicons-admin-tools', 75 );
70			add_submenu_page( $menu_slug, esc_attr__( 'Marketing', 'jetpack' ), __( 'Marketing', 'jetpack' ), 'publish_posts', $menu_slug );
71			add_submenu_page( $menu_slug, esc_attr__( 'Earn', 'jetpack' ), __( 'Earn', 'jetpack' ), 'manage_options', 'https://wordpress.com/earn/' . $this->domain );
72
73			// Import/Export on Jetpack sites is always handled on WP Admin.
74			add_submenu_page( $menu_slug, esc_attr__( 'Import', 'jetpack' ), __( 'Import', 'jetpack' ), 'import', 'import.php' );
75			add_submenu_page( $menu_slug, esc_attr__( 'Export', 'jetpack' ), __( 'Export', 'jetpack' ), 'export', 'export.php' );
76
77			}
78
79			/**
80			* Adds WP Admin menu.
81			*/
82			public function add_wp_admin_menu() {
83			global $menu;
84			$menu_slug = 'index.php';
85
86			remove_menu_page( $menu_slug );
87			$this->remove_submenus( $menu_slug );
88
89			// Attempt to get last position.
90			ksort( $menu );
91			end( $menu );
92			$position = key( $menu );
93
94			$this->add_admin_menu_separator( ++$position );
95
96			add_menu_page( __( 'WP Admin', 'jetpack' ), __( 'WP Admin', 'jetpack' ), 'read', $menu_slug, null, 'dashicons-wordpress-alt', $position );
97			}
98
99			/**
100			* Adds Appearance menu.
101			*
102			* @param bool $wp_admin_themes Optional. Whether Themes link should point to Calypso or wp-admin. Default false (Calypso).
103			* @param bool $wp_admin_customize Optional. Whether Customize link should point to Calypso or wp-admin. Default false (Calypso).
104			*/
105			public function add_appearance_menu( $wp_admin_themes = false, $wp_admin_customize = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
106			$appearance_cap = current_user_can( 'switch_themes' ) ? 'switch_themes' : 'edit_theme_options';
107			$admin_slug = 'themes.php';
108			$menu_slug = 'https://wordpress.com/themes/' . $this->domain;
109
110			// Remove all submenus except Themes and Customize to mimic the old Calypso navigation.
111			remove_menu_page( $admin_slug );
112			$this->remove_submenus( $admin_slug );
113			add_menu_page( esc_attr__( 'Appearance', 'jetpack' ), __( 'Appearance', 'jetpack' ), $appearance_cap, $menu_slug, null, 'dashicons-admin-appearance', 60 );
114			add_submenu_page( $menu_slug, esc_attr__( 'Themes', 'jetpack' ), __( 'Themes', 'jetpack' ), 'switch_themes', $menu_slug );
115
116			// Customize on Jetpack sites is always done on WP Admin (unsupported by Calypso).
117			add_submenu_page( $menu_slug, esc_attr__( 'Customize', 'jetpack' ), __( 'Customize', 'jetpack' ), 'customize', 'customize.php' );
118			}
119
120			/**
121			* Adds Posts menu.
122			*
123			* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
124			*/
125			public function add_posts_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
126			parent::add_posts_menu();
127
128			// Remove all submenus to mimic the old Calypso navigation.
129			$this->remove_submenus( 'https://wordpress.com/posts/' . $this->domain );
130			}
131
132			/**
133			* Adds Page menu.
134			*
135			* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
136			*/
137			public function add_page_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
138			parent::add_page_menu();
139
140			// Remove all submenus to mimic the old Calypso navigation.
141			$this->remove_submenus( 'https://wordpress.com/pages/' . $this->domain );
142			}
143
144			/**
145			* Adds a custom post type menu.
146			*
147			* @param string $post_type Custom post type.
148			* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
149			*/
150			public function add_custom_post_type_menu( $post_type, $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
151			parent::add_custom_post_type_menu( $post_type );
152
153			// Remove all submenus to mimic the old Calypso navigation.
154			$this->remove_submenus( 'https://wordpress.com/types/' . $post_type . '/' . $this->domain );
155			}
156
157			/**
158			* Adds Users menu.
159			*
160			* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
161			*/
162			public function add_users_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
163			parent::add_users_menu();
164
165			// Remove all submenus to mimic the old Calypso navigation.
166			$this->remove_submenus( 'https://wordpress.com/people/team/' . $this->domain );
167			}
168
169			/**
170			* Whether to use wp-admin pages rather than Calypso.
171			*
172			* @return bool
173			*/
174			public function should_link_to_wp_admin() {
175			// Force Calypso links on Jetpack sites since Nav Unification is disabled on WP Admin.
176			return false;
177			}
178
179			/**
180			* Migrates submenu items from wp-admin menu slugs to Calypso menu slugs.
181			*
182			* @param string $old_slug WP-Admin menu slug.
183			* @param string $new_slug Calypso menu slug. (Calypso URL).
184			*/
185			public function migrate_submenus( $old_slug, $new_slug ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
186			// Do not migrate menu on Jetpack sites, since we don't want WP Admin links.
187			// Instead we remove the submenu since they won't be used.
188			$this->remove_submenus( $old_slug );
189			}
190			}
191

Automattic / jetpack

Push — update/admin-menu-jetpack-site... ( 93812c )

Jetpack_Admin_Menu::add_jetpack_menu() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like