Atomic_Admin_Menu::add_page_menu() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master' into..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/node-version ( 857559...c25464 )

by Jeremy

created 2021-03-24 15:53 UTC

Atomic_Admin_Menu::add_page_menu() A

↳ Parent: Atomic_Admin_Menu

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * Atomic Admin Menu file.
 *
 * @package automattic/jetpack
 */

namespace Automattic\Jetpack\Dashboard_Customizations;

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

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

	/**
	 * Atomic_Admin_Menu constructor.
	 */
	protected function __construct() {
		parent::__construct();

		add_action( 'wp_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );
		add_action( 'admin_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );

		add_action(
			'admin_menu',
			function () {
				remove_action( 'admin_menu', 'gutenberg_menu', 9 );
			},
			0
		);
	}

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

	/**
	 * Create the desired menu output.
	 */
	public function reregister_menu_items() {
		parent::reregister_menu_items();

		$this->add_my_home_menu();

		// Not needed outside of wp-admin.
		if ( ! $this->is_api_request ) {
			$this->add_browse_sites_link();
			$this->add_site_card_menu();
			$this->add_new_site_link();
		}

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

	/**
	 * Forces Posts menu to WPAdmin for Atomic sites only.
	 * Overloads `add_posts_menu` in parent class.
	 *
	 * @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
		return false; // return explicit `false` to force WPAdmin links.
	}

	/**
	 * Forces Pages menu to WPAdmin for Atomic sites only.
	 * Overloads `add_page_menu` in parent class.
	 *
	 * @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
		return false; // return explicit `false` to force WPAdmin links.
	}

	/**
	 * Adds Plugins menu.
	 *
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_plugins_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		// Plugins on Atomic sites are always managed on WP Admin.
		parent::add_plugins_menu( true );
	}

	/**
	 * Adds the site switcher link if user has more than one site.
	 */
	public function add_browse_sites_link() {
		$site_count = get_user_option( 'wpcom_site_count' );
		if ( ! $site_count || $site_count < 2 ) {
			return;
		}

		// Add the menu item.
		add_menu_page( __( 'site-switcher', 'jetpack' ), __( 'Browse sites', 'jetpack' ), 'read', 'https://wordpress.com/home', null, 'dashicons-arrow-left-alt2', 0 );
		add_filter( 'add_menu_classes', array( $this, 'set_browse_sites_link_class' ) );
	}

	/**
	 * Adds a custom element class for Site Switcher menu item.
	 *
	 * @param array $menu Associative array of administration menu items.
	 *
	 * @return array
	 */
	public function set_browse_sites_link_class( array $menu ) {
		foreach ( $menu as $key => $menu_item ) {
			if ( 'site-switcher' !== $menu_item[3] ) {
				continue;
			}

			$menu[ $key ][4] = add_cssclass( 'site-switcher', $menu_item[4] );
			break;
		}

		return $menu;
	}

	/**
	 * Adds a link to the menu to create a new site.
	 */
	public function add_new_site_link() {
		global $menu;

		$site_count = get_user_option( 'wpcom_site_count' );
		if ( $site_count && $site_count > 1 ) {
			return;
		}

		// Attempt to get last position.
		$position = 1000;
		while ( isset( $menu[ $position ] ) ) {
			$position++;
		}

		$this->add_admin_menu_separator( ++$position );
		add_menu_page( __( 'Add new site', 'jetpack' ), __( 'Add new site', 'jetpack' ), 'read', 'https://wordpress.com/start?ref=calypso-sidebar', null, 'dashicons-plus-alt', ++$position );
	}

	/**
	 * Adds site card component.
	 */
	public function add_site_card_menu() {
		$default   = 'data:image/svg+xml,' . rawurlencode( '<svg class="gridicon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>Globe</title><rect fill-opacity="0" x="0" width="24" height="24"/><g><path fill="#fff" d="M12 2C6.477 2 2 6.477 2 12s4.477 10 10 10 10-4.477 10-10S17.523 2 12 2zm0 18l2-2 1-1v-2h-2v-1l-1-1H9v3l2 2v1.93c-3.94-.494-7-3.858-7-7.93l1 1h2v-2h2l3-3V6h-2L9 5v-.41C9.927 4.21 10.94 4 12 4s2.073.212 3 .59V6l-1 1v2l1 1 3.13-3.13c.752.897 1.304 1.964 1.606 3.13H18l-2 2v2l1 1h2l.286.286C18.03 18.06 15.24 20 12 20z"/></g></svg>' );
		$icon      = get_site_icon_url( 32, $default );
		$blog_name = get_option( 'blogname' ) !== '' ? get_option( 'blogname' ) : $this->domain;

		$badge = '';
		if ( function_exists( 'site_is_private' ) && site_is_private() ) {
			$badge .= sprintf(
				'<span class="site__badge site__badge-private">%s</span>',
				site_is_coming_soon() ? esc_html__( 'Coming Soon', 'jetpack' ) : esc_html__( 'Private', 'jetpack' )
			);
		}

		$site_card = '
<div class="site__info">
	<div class="site__title">%1$s</div>
	<div class="site__domain">%2$s</div>
	%3$s
</div>';

		$site_card = sprintf(
			$site_card,
			$blog_name,
			$this->domain,
			$badge
		);

		add_menu_page( 'site-card', $site_card, 'read', get_home_url(), null, $icon, 1 );
		add_filter( 'add_menu_classes', array( $this, 'set_site_card_menu_class' ) );
	}

	/**
	 * Adds a custom element class and id for Site Card's menu item.
	 *
	 * @param array $menu Associative array of administration menu items.
	 *
	 * @return array
	 */
	public function set_site_card_menu_class( array $menu ) {
		foreach ( $menu as $key => $menu_item ) {
			if ( 'site-card' !== $menu_item[3] ) {
				continue;
			}

			$classes = ' toplevel_page_site-card';

			// webclip.png is the default on WoA sites. Anything other than that means we have a custom site icon.
			if ( has_site_icon() && 'https://s0.wp.com/i/webclip.png' !== get_site_icon_url( 512 ) ) {
				$classes .= ' has-site-icon';
			}

			$menu[ $key ][4] = $menu_item[4] . $classes;
			$menu[ $key ][5] = 'toplevel_page_site_card';
			break;
		}

		return $menu;
	}

	/**
	 * Adds Upgrades menu.
	 */
	public function add_upgrades_menu() {
		parent::add_upgrades_menu();

		add_submenu_page( 'paid-upgrades.php', __( 'Domains', 'jetpack' ), __( 'Domains', 'jetpack' ), 'manage_options', 'https://wordpress.com/domains/manage/' . $this->domain, null, 10 );
	}

	/**
	 * 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
		// Export on Atomic sites is always handled on WP Admin.
		parent::add_tools_menu( $wp_admin_import, true );
	}

	/**
	 * Adds Settings menu.
	 *
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_options_menu( $wp_admin = false ) {
		parent::add_options_menu( $wp_admin );

		add_submenu_page( 'options-general.php', esc_attr__( 'Hosting Configuration', 'jetpack' ), __( 'Hosting Configuration', 'jetpack' ), 'manage_options', 'https://wordpress.com/hosting-config/' . $this->domain, null, 6 );

		// No need to add a menu linking to WP Admin if there is already one.
		if ( ! $wp_admin ) {
			add_submenu_page( 'options-general.php', esc_attr__( 'Advanced General', 'jetpack' ), __( 'Advanced General', 'jetpack' ), 'manage_options', 'options-general.php' );
			add_submenu_page( 'options-general.php', esc_attr__( 'Advanced Writing', 'jetpack' ), __( 'Advanced Writing', 'jetpack' ), 'manage_options', 'options-writing.php' );
		}
	}

	/**
	 * 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
		// Customize on Atomic sites is always done on WP Admin.
		parent::add_appearance_menu( $wp_admin_themes, true );

		add_submenu_page( 'themes.php', esc_attr__( 'Add New Theme', 'jetpack' ), __( 'Add New Theme', 'jetpack' ), 'install_themes', 'theme-install.php', null, 1 );
	}

	/**
	 * 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 ) {
		parent::add_users_menu( $wp_admin );

		add_submenu_page( 'users.php', esc_attr__( 'Advanced Users Management', 'jetpack' ), __( 'Advanced Users Management', 'jetpack' ), 'list_users', 'users.php', null, 2 );
	}

	/**
	 * Also remove the Gutenberg plugin menu.
	 *
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
	 */
	public function add_gutenberg_menus( $wp_admin = false ) {
		// Always remove the Gutenberg menu.
		remove_menu_page( 'gutenberg' );
		parent::add_gutenberg_menus( $wp_admin );
	}
}


1		<?php
2		/**
3		* Atomic Admin Menu file.
4		*
5		* @package automattic/jetpack
6		*/
7
8		namespace Automattic\Jetpack\Dashboard_Customizations;
9
10		require_once __DIR__ . '/class-admin-menu.php';
11
12		/**
13		* Class Atomic_Admin_Menu.
14		*/
15		class Atomic_Admin_Menu extends Admin_Menu {
16
17		/**
18		* Atomic_Admin_Menu constructor.
19		*/
20		protected function __construct() {
21		parent::__construct();
22
23		add_action( 'wp_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );
24		add_action( 'admin_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 );
25
26		add_action(
27		'admin_menu',
28		function () {
29		remove_action( 'admin_menu', 'gutenberg_menu', 9 );
30		},
31		0
32		);
33		}
34
35		/**
36		* Dequeues unnecessary scripts.
37		*/
38		public function dequeue_scripts() {
39		wp_dequeue_script( 'a8c_wpcom_masterbar_overrides' ); // Initially loaded in modules/masterbar/masterbar/class-masterbar.php.
40		}
41
42		/**
43		* Create the desired menu output.
44		*/
45	View Code Duplication	public function reregister_menu_items() {
46		parent::reregister_menu_items();
47
48		$this->add_my_home_menu();
49
50		// Not needed outside of wp-admin.
51		if ( ! $this->is_api_request ) {
52		$this->add_browse_sites_link();
53		$this->add_site_card_menu();
54		$this->add_new_site_link();
55		}
56
57		ksort( $GLOBALS['menu'] );
58		}
59
60		/**
61		* Forces Posts menu to WPAdmin for Atomic sites only.
62		* Overloads `add_posts_menu` in parent class.
63		*
64		* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
65		*/
66		public function add_posts_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
67		return false; // return explicit `false` to force WPAdmin links.
68		}
69
70		/**
71		* Forces Pages menu to WPAdmin for Atomic sites only.
72		* Overloads `add_page_menu` in parent class.
73		*
74		* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
75		*/
76		public function add_page_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
77		return false; // return explicit `false` to force WPAdmin links.
78		}
79
80		/**
81		* Adds Plugins menu.
82		*
83		* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
84		*/
85		public function add_plugins_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
86		// Plugins on Atomic sites are always managed on WP Admin.
87		parent::add_plugins_menu( true );
88		}
89
90		/**
91		* Adds the site switcher link if user has more than one site.
92		*/
93		public function add_browse_sites_link() {
94		$site_count = get_user_option( 'wpcom_site_count' );
95		if ( ! $site_count \|\| $site_count < 2 ) {
96		return;
97		}
98
99		// Add the menu item.
100		add_menu_page( __( 'site-switcher', 'jetpack' ), __( 'Browse sites', 'jetpack' ), 'read', 'https://wordpress.com/home', null, 'dashicons-arrow-left-alt2', 0 );
101		add_filter( 'add_menu_classes', array( $this, 'set_browse_sites_link_class' ) );
102		}
103
104		/**
105		* Adds a custom element class for Site Switcher menu item.
106		*
107		* @param array $menu Associative array of administration menu items.
108		*
109		* @return array
110		*/
111	View Code Duplication	public function set_browse_sites_link_class( array $menu ) {
112		foreach ( $menu as $key => $menu_item ) {
113		if ( 'site-switcher' !== $menu_item[3] ) {
114		continue;
115		}
116
117		$menu[ $key ][4] = add_cssclass( 'site-switcher', $menu_item[4] );
118		break;
119		}
120
121		return $menu;
122		}
123
124		/**
125		* Adds a link to the menu to create a new site.
126		*/
127		public function add_new_site_link() {
128		global $menu;
129
130		$site_count = get_user_option( 'wpcom_site_count' );
131		if ( $site_count && $site_count > 1 ) {
132		return;
133		}
134
135		// Attempt to get last position.
136		$position = 1000;
137		while ( isset( $menu[ $position ] ) ) {
138		$position++;
139		}
140
141		$this->add_admin_menu_separator( ++$position );
142		add_menu_page( __( 'Add new site', 'jetpack' ), __( 'Add new site', 'jetpack' ), 'read', 'https://wordpress.com/start?ref=calypso-sidebar', null, 'dashicons-plus-alt', ++$position );
143		}
144
145		/**
146		* Adds site card component.
147		*/
148		public function add_site_card_menu() {
149		$default = 'data:image/svg+xml,' . rawurlencode( '<svg class="gridicon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>Globe</title><rect fill-opacity="0" x="0" width="24" height="24"/><g><path fill="#fff" d="M12 2C6.477 2 2 6.477 2 12s4.477 10 10 10 10-4.477 10-10S17.523 2 12 2zm0 18l2-2 1-1v-2h-2v-1l-1-1H9v3l2 2v1.93c-3.94-.494-7-3.858-7-7.93l1 1h2v-2h2l3-3V6h-2L9 5v-.41C9.927 4.21 10.94 4 12 4s2.073.212 3 .59V6l-1 1v2l1 1 3.13-3.13c.752.897 1.304 1.964 1.606 3.13H18l-2 2v2l1 1h2l.286.286C18.03 18.06 15.24 20 12 20z"/></g></svg>' );
150		$icon = get_site_icon_url( 32, $default );
151		$blog_name = get_option( 'blogname' ) !== '' ? get_option( 'blogname' ) : $this->domain;
152
153		$badge = '';
154		if ( function_exists( 'site_is_private' ) && site_is_private() ) {
155		$badge .= sprintf(
156		'<span class="site__badge site__badge-private">%s</span>',
157		site_is_coming_soon() ? esc_html__( 'Coming Soon', 'jetpack' ) : esc_html__( 'Private', 'jetpack' )
158		);
159		}
160
161		$site_card = '
162		<div class="site__info">
163		<div class="site__title">%1$s</div>
164		<div class="site__domain">%2$s</div>
165		%3$s
166		</div>';
167
168		$site_card = sprintf(
169		$site_card,
170		$blog_name,
171		$this->domain,
172		$badge
173		);
174
175		add_menu_page( 'site-card', $site_card, 'read', get_home_url(), null, $icon, 1 );
176		add_filter( 'add_menu_classes', array( $this, 'set_site_card_menu_class' ) );
177		}
178
179		/**
180		* Adds a custom element class and id for Site Card's menu item.
181		*
182		* @param array $menu Associative array of administration menu items.
183		*
184		* @return array
185		*/
186		public function set_site_card_menu_class( array $menu ) {
187		foreach ( $menu as $key => $menu_item ) {
188		if ( 'site-card' !== $menu_item[3] ) {
189		continue;
190		}
191
192		$classes = ' toplevel_page_site-card';
193
194		// webclip.png is the default on WoA sites. Anything other than that means we have a custom site icon.
195		if ( has_site_icon() && 'https://s0.wp.com/i/webclip.png' !== get_site_icon_url( 512 ) ) {
196		$classes .= ' has-site-icon';
197		}
198
199		$menu[ $key ][4] = $menu_item[4] . $classes;
200		$menu[ $key ][5] = 'toplevel_page_site_card';
201		break;
202		}
203
204		return $menu;
205		}
206
207		/**
208		* Adds Upgrades menu.
209		*/
210		public function add_upgrades_menu() {
211		parent::add_upgrades_menu();
212
213		add_submenu_page( 'paid-upgrades.php', __( 'Domains', 'jetpack' ), __( 'Domains', 'jetpack' ), 'manage_options', 'https://wordpress.com/domains/manage/' . $this->domain, null, 10 );
214		}
215
216		/**
217		* Adds Tools menu.
218		*
219		* @param bool $wp_admin_import Optional. Whether Import link should point to Calypso or wp-admin. Default false (Calypso).
220		* @param bool $wp_admin_export Optional. Whether Export link should point to Calypso or wp-admin. Default false (Calypso).
221		*/
222		public function add_tools_menu( $wp_admin_import = false, $wp_admin_export = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
223		// Export on Atomic sites is always handled on WP Admin.
224		parent::add_tools_menu( $wp_admin_import, true );
225		}
226
227		/**
228		* Adds Settings menu.
229		*
230		* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
231		*/
232		public function add_options_menu( $wp_admin = false ) {
233		parent::add_options_menu( $wp_admin );
234
235		add_submenu_page( 'options-general.php', esc_attr__( 'Hosting Configuration', 'jetpack' ), __( 'Hosting Configuration', 'jetpack' ), 'manage_options', 'https://wordpress.com/hosting-config/' . $this->domain, null, 6 );
236
237		// No need to add a menu linking to WP Admin if there is already one.
238		if ( ! $wp_admin ) {
239		add_submenu_page( 'options-general.php', esc_attr__( 'Advanced General', 'jetpack' ), __( 'Advanced General', 'jetpack' ), 'manage_options', 'options-general.php' );
240		add_submenu_page( 'options-general.php', esc_attr__( 'Advanced Writing', 'jetpack' ), __( 'Advanced Writing', 'jetpack' ), 'manage_options', 'options-writing.php' );
241		}
242		}
243
244		/**
245		* Adds Appearance menu.
246		*
247		* @param bool $wp_admin_themes Optional. Whether Themes link should point to Calypso or wp-admin. Default false (Calypso).
248		* @param bool $wp_admin_customize Optional. Whether Customize link should point to Calypso or wp-admin. Default false (Calypso).
249		*/
250		public function add_appearance_menu( $wp_admin_themes = false, $wp_admin_customize = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
251		// Customize on Atomic sites is always done on WP Admin.
252		parent::add_appearance_menu( $wp_admin_themes, true );
253
254		add_submenu_page( 'themes.php', esc_attr__( 'Add New Theme', 'jetpack' ), __( 'Add New Theme', 'jetpack' ), 'install_themes', 'theme-install.php', null, 1 );
255		}
256
257		/**
258		* Adds Users menu.
259		*
260		* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
261		*/
262		public function add_users_menu( $wp_admin = false ) {
263		parent::add_users_menu( $wp_admin );
264
265		add_submenu_page( 'users.php', esc_attr__( 'Advanced Users Management', 'jetpack' ), __( 'Advanced Users Management', 'jetpack' ), 'list_users', 'users.php', null, 2 );
266		}
267
268		/**
269		* Also remove the Gutenberg plugin menu.
270		*
271		* @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
272		*/
273		public function add_gutenberg_menus( $wp_admin = false ) {
274		// Always remove the Gutenberg menu.
275		remove_menu_page( 'gutenberg' );
276		parent::add_gutenberg_menus( $wp_admin );
277		}
278		}
279

Automattic / jetpack

Push — update/node-version ( 857559...c25464 )

Atomic_Admin_Menu::add_page_menu() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like