admin-menu-rtl.css
2 years ago
admin-menu-rtl.min.css
2 years ago
admin-menu.css
2 years ago
admin-menu.js
3 years ago
admin-menu.min.css
2 years ago
class-admin-menu.php
2 years ago
class-atomic-admin-menu.php
2 years ago
class-base-admin-menu.php
3 years ago
class-dashboard-switcher-tracking.php
3 years ago
class-domain-only-admin-menu.php
2 years ago
class-jetpack-admin-menu.php
2 years ago
class-p2-admin-menu.php
4 years ago
class-wpcom-admin-menu.php
2 years ago
class-wpcom-email-subscription-checker.php
3 years ago
dashicon-set.php
4 years ago
globe-icon.svg
3 years ago
load.php
3 years ago
menu-mappings.php
3 years ago
class-atomic-admin-menu.php
448 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Atomic Admin Menu file. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | namespace Automattic\Jetpack\Dashboard_Customizations; |
| 9 | |
| 10 | use Automattic\Jetpack\Connection\Client; |
| 11 | use Automattic\Jetpack\Current_Plan as Jetpack_Plan; |
| 12 | use Automattic\Jetpack\Status; |
| 13 | |
| 14 | require_once __DIR__ . '/class-admin-menu.php'; |
| 15 | |
| 16 | /** |
| 17 | * Class Atomic_Admin_Menu. |
| 18 | */ |
| 19 | class Atomic_Admin_Menu extends Admin_Menu { |
| 20 | |
| 21 | /** |
| 22 | * Atomic_Admin_Menu constructor. |
| 23 | */ |
| 24 | protected function __construct() { |
| 25 | parent::__construct(); |
| 26 | |
| 27 | add_action( 'wp_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 ); |
| 28 | add_action( 'admin_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 ); |
| 29 | add_action( 'wp_ajax_sidebar_state', array( $this, 'ajax_sidebar_state' ) ); |
| 30 | add_action( 'wp_ajax_jitm_dismiss', array( $this, 'wp_ajax_jitm_dismiss' ) ); |
| 31 | add_action( 'wp_ajax_upsell_nudge_jitm', array( $this, 'wp_ajax_upsell_nudge_jitm' ) ); |
| 32 | |
| 33 | if ( ! $this->is_api_request ) { |
| 34 | add_filter( 'submenu_file', array( $this, 'override_the_theme_installer' ), 10, 2 ); |
| 35 | } |
| 36 | |
| 37 | add_action( |
| 38 | 'admin_menu', |
| 39 | function () { |
| 40 | remove_action( 'admin_menu', 'gutenberg_menu', 9 ); |
| 41 | }, |
| 42 | 0 |
| 43 | ); |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Dequeues unnecessary scripts. |
| 48 | */ |
| 49 | public function dequeue_scripts() { |
| 50 | wp_dequeue_script( 'a8c_wpcom_masterbar_overrides' ); // Initially loaded in modules/masterbar/masterbar/class-masterbar.php. |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Determines whether the current locale is right-to-left (RTL). |
| 55 | * |
| 56 | * Performs the check against the current locale set on the WordPress.com's account settings. |
| 57 | * See `Masterbar::__construct` in `modules/masterbar/masterbar/class-masterbar.php`. |
| 58 | */ |
| 59 | public function is_rtl() { |
| 60 | return get_user_option( 'jetpack_wpcom_is_rtl' ); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Create the desired menu output. |
| 65 | */ |
| 66 | public function reregister_menu_items() { |
| 67 | parent::reregister_menu_items(); |
| 68 | |
| 69 | $this->add_my_home_menu(); |
| 70 | $this->remove_gutenberg_menu(); |
| 71 | |
| 72 | if ( ! get_option( 'wpcom_is_staging_site' ) ) { |
| 73 | $this->add_my_mailboxes_menu(); |
| 74 | } |
| 75 | |
| 76 | // Not needed outside of wp-admin. |
| 77 | if ( ! $this->is_api_request ) { |
| 78 | $this->add_browse_sites_link(); |
| 79 | $this->add_site_card_menu(); |
| 80 | $this->add_new_site_link(); |
| 81 | } |
| 82 | |
| 83 | $this->add_woocommerce_installation_menu(); |
| 84 | ksort( $GLOBALS['menu'] ); |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * Get the preferred view for the given screen. |
| 89 | * |
| 90 | * @param string $screen Screen identifier. |
| 91 | * @param bool $fallback_global_preference (Optional) Whether the global preference for all screens should be used |
| 92 | * as fallback if there is no specific preference for the given screen. |
| 93 | * Default: true. |
| 94 | * @return string |
| 95 | */ |
| 96 | public function get_preferred_view( $screen, $fallback_global_preference = true ) { |
| 97 | // Export on Atomic sites are always managed on WP Admin. |
| 98 | if ( in_array( $screen, array( 'export.php' ), true ) ) { |
| 99 | return self::CLASSIC_VIEW; |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * When Jetpack SSO is disabled, we need to force Calypso because it might create confusion to be redirected to WP-Admin. |
| 104 | * Furthermore, because we don't display the quick switcher, users having an WP-Admin interface by default won't be able to go back to the Calyso version. |
| 105 | */ |
| 106 | if ( ! \Jetpack::is_module_active( 'sso' ) ) { |
| 107 | return self::DEFAULT_VIEW; |
| 108 | } |
| 109 | |
| 110 | return parent::get_preferred_view( $screen, $fallback_global_preference ); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Adds Users menu. |
| 115 | */ |
| 116 | public function add_users_menu() { |
| 117 | add_submenu_page( 'users.php', esc_attr__( 'Subscribers', 'jetpack' ), __( 'Subscribers', 'jetpack' ), 'list_users', 'https://wordpress.com/subscribers/' . $this->domain, null, 3 ); |
| 118 | |
| 119 | return parent::add_users_menu(); |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Adds Plugins menu. |
| 124 | */ |
| 125 | public function add_plugins_menu() { |
| 126 | global $submenu; |
| 127 | |
| 128 | // Calypso plugins screens link. |
| 129 | $plugins_slug = 'https://wordpress.com/plugins/' . $this->domain; |
| 130 | |
| 131 | // Link to the Marketplace on sites that can't manage plugins. |
| 132 | if ( |
| 133 | function_exists( 'wpcom_site_has_feature' ) && |
| 134 | ! wpcom_site_has_feature( \WPCOM_Features::MANAGE_PLUGINS ) |
| 135 | ) { |
| 136 | add_menu_page( __( 'Plugins', 'jetpack' ), __( 'Plugins', 'jetpack' ), 'manage_options', $plugins_slug, null, 'dashicons-admin-plugins', '65' ); |
| 137 | return; |
| 138 | } |
| 139 | |
| 140 | if ( ! isset( $submenu['plugins.php'] ) ) { |
| 141 | return; |
| 142 | } |
| 143 | |
| 144 | $plugins_submenu = $submenu['plugins.php']; |
| 145 | |
| 146 | // Move "Add New" plugin submenu to the top position. |
| 147 | foreach ( $plugins_submenu as $submenu_key => $submenu_keys ) { |
| 148 | if ( 'plugin-install.php' === $submenu_keys[2] ) { |
| 149 | // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited |
| 150 | $submenu['plugins.php'] = array( $submenu_key => $plugins_submenu[ $submenu_key ] ) + $plugins_submenu; |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | $submenus_to_update = array( 'plugin-install.php' => $plugins_slug ); |
| 155 | |
| 156 | $this->update_submenus( 'plugins.php', $submenus_to_update ); |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Adds the site switcher link if user has more than one site. |
| 161 | */ |
| 162 | public function add_browse_sites_link() { |
| 163 | $site_count = get_user_option( 'wpcom_site_count' ); |
| 164 | if ( ! $site_count || $site_count < 2 ) { |
| 165 | return; |
| 166 | } |
| 167 | |
| 168 | // Add the menu item. |
| 169 | add_menu_page( __( 'site-switcher', 'jetpack' ), __( 'Browse sites', 'jetpack' ), 'read', 'https://wordpress.com/sites', null, 'dashicons-arrow-left-alt2', 0 ); |
| 170 | add_filter( 'add_menu_classes', array( $this, 'set_browse_sites_link_class' ) ); |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * Adds a custom element class for Site Switcher menu item. |
| 175 | * |
| 176 | * @param array $menu Associative array of administration menu items. |
| 177 | * |
| 178 | * @return array |
| 179 | */ |
| 180 | public function set_browse_sites_link_class( array $menu ) { |
| 181 | foreach ( $menu as $key => $menu_item ) { |
| 182 | if ( 'site-switcher' !== $menu_item[3] ) { |
| 183 | continue; |
| 184 | } |
| 185 | |
| 186 | $menu[ $key ][4] = add_cssclass( 'site-switcher', $menu_item[4] ); |
| 187 | break; |
| 188 | } |
| 189 | |
| 190 | return $menu; |
| 191 | } |
| 192 | |
| 193 | /** |
| 194 | * Adds a link to the menu to create a new site. |
| 195 | */ |
| 196 | public function add_new_site_link() { |
| 197 | $site_count = get_user_option( 'wpcom_site_count' ); |
| 198 | if ( $site_count && $site_count > 1 ) { |
| 199 | return; |
| 200 | } |
| 201 | |
| 202 | add_menu_page( __( 'Add New Site', 'jetpack' ), __( 'Add New Site', 'jetpack' ), 'read', 'https://wordpress.com/start?ref=calypso-sidebar', null, 'dashicons-plus-alt' ); |
| 203 | } |
| 204 | |
| 205 | /** |
| 206 | * Adds site card component. |
| 207 | */ |
| 208 | public function add_site_card_menu() { |
| 209 | $default = plugins_url( 'globe-icon.svg', __FILE__ ); |
| 210 | $icon = get_site_icon_url( 32, $default ); |
| 211 | $blog_name = get_option( 'blogname' ) !== '' ? get_option( 'blogname' ) : $this->domain; |
| 212 | $is_coming_soon = ( new Status() )->is_coming_soon(); |
| 213 | |
| 214 | $badge = ''; |
| 215 | |
| 216 | if ( get_option( 'wpcom_is_staging_site' ) ) { |
| 217 | $badge .= '<span class="site__badge site__badge-staging">' . esc_html__( 'Staging', 'jetpack' ) . '</span>'; |
| 218 | } |
| 219 | |
| 220 | if ( ( function_exists( 'site_is_private' ) && site_is_private() ) || $is_coming_soon ) { |
| 221 | $badge .= sprintf( |
| 222 | '<span class="site__badge site__badge-private">%s</span>', |
| 223 | $is_coming_soon ? esc_html__( 'Coming Soon', 'jetpack' ) : esc_html__( 'Private', 'jetpack' ) |
| 224 | ); |
| 225 | } |
| 226 | |
| 227 | $site_card = ' |
| 228 | <div class="site__info"> |
| 229 | <div class="site__title">%1$s</div> |
| 230 | <div class="site__domain">%2$s</div> |
| 231 | %3$s |
| 232 | </div>'; |
| 233 | |
| 234 | $site_card = sprintf( |
| 235 | $site_card, |
| 236 | $blog_name, |
| 237 | $this->domain, |
| 238 | $badge |
| 239 | ); |
| 240 | |
| 241 | add_menu_page( 'site-card', $site_card, 'read', get_home_url(), null, $icon, 1 ); |
| 242 | add_filter( 'add_menu_classes', array( $this, 'set_site_card_menu_class' ) ); |
| 243 | } |
| 244 | |
| 245 | /** |
| 246 | * Adds a custom element class and id for Site Card's menu item. |
| 247 | * |
| 248 | * @param array $menu Associative array of administration menu items. |
| 249 | * |
| 250 | * @return array |
| 251 | */ |
| 252 | public function set_site_card_menu_class( array $menu ) { |
| 253 | foreach ( $menu as $key => $menu_item ) { |
| 254 | if ( 'site-card' !== $menu_item[3] ) { |
| 255 | continue; |
| 256 | } |
| 257 | |
| 258 | $classes = ' toplevel_page_site-card'; |
| 259 | |
| 260 | // webclip.png is the default on WoA sites. Anything other than that means we have a custom site icon. |
| 261 | if ( has_site_icon() && 'https://s0.wp.com/i/webclip.png' !== get_site_icon_url( 512 ) ) { |
| 262 | $classes .= ' has-site-icon'; |
| 263 | } |
| 264 | |
| 265 | $menu[ $key ][4] = $menu_item[4] . $classes; |
| 266 | $menu[ $key ][5] = 'toplevel_page_site_card'; |
| 267 | break; |
| 268 | } |
| 269 | |
| 270 | return $menu; |
| 271 | } |
| 272 | |
| 273 | /** |
| 274 | * Returns the first available upsell nudge. |
| 275 | * |
| 276 | * @return array |
| 277 | */ |
| 278 | public function get_upsell_nudge() { |
| 279 | $jitm = \Automattic\Jetpack\JITMS\JITM::get_instance(); |
| 280 | $message_path = 'calypso:sites:sidebar_notice'; |
| 281 | $message = $jitm->get_messages( $message_path, wp_json_encode( array( 'message_path' => $message_path ) ), false ); |
| 282 | |
| 283 | if ( isset( $message[0] ) ) { |
| 284 | $message = $message[0]; |
| 285 | return array( |
| 286 | 'content' => $message->content->message, |
| 287 | 'cta' => $message->CTA->message, // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 288 | 'link' => $message->CTA->link, // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 289 | 'tracks_impression_event_name' => $message->tracks->display->name, |
| 290 | 'tracks_impression_cta_name' => $message->tracks->display->props->cta_name, |
| 291 | 'tracks_click_event_name' => $message->tracks->click->name, |
| 292 | 'tracks_click_cta_name' => $message->tracks->click->props->cta_name, |
| 293 | 'dismissible' => $message->is_dismissible, |
| 294 | 'feature_class' => $message->feature_class, |
| 295 | 'id' => $message->id, |
| 296 | ); |
| 297 | } |
| 298 | } |
| 299 | |
| 300 | /** |
| 301 | * Adds Stats menu. |
| 302 | */ |
| 303 | public function add_stats_menu() { |
| 304 | $menu_title = __( 'Stats', 'jetpack' ); |
| 305 | |
| 306 | if ( |
| 307 | ! $this->is_api_request && |
| 308 | \Jetpack::is_module_active( 'stats' ) && |
| 309 | function_exists( 'stats_get_image_chart_src' ) |
| 310 | ) { |
| 311 | $img_src = esc_attr( |
| 312 | stats_get_image_chart_src( 'admin-bar-hours-scale-2x', array( 'masterbar' => '' ) ) |
| 313 | ); |
| 314 | $alt = esc_attr__( 'Hourly views', 'jetpack' ); |
| 315 | |
| 316 | $menu_title .= "<img class='sidebar-unified__sparkline' src='$img_src' width='80' height='20' alt='$alt'>"; |
| 317 | } |
| 318 | |
| 319 | add_menu_page( __( 'Stats', 'jetpack' ), $menu_title, 'view_stats', 'https://wordpress.com/stats/day/' . $this->domain, null, 'dashicons-chart-bar', 3 ); |
| 320 | } |
| 321 | |
| 322 | /** |
| 323 | * Adds Upgrades menu. |
| 324 | * |
| 325 | * @param string $plan The current WPCOM plan of the blog. |
| 326 | */ |
| 327 | public function add_upgrades_menu( $plan = null ) { |
| 328 | |
| 329 | if ( get_option( 'wpcom_is_staging_site' ) ) { |
| 330 | return; |
| 331 | } |
| 332 | $products = Jetpack_Plan::get(); |
| 333 | if ( array_key_exists( 'product_name_short', $products ) ) { |
| 334 | $plan = $products['product_name_short']; |
| 335 | } |
| 336 | parent::add_upgrades_menu( $plan ); |
| 337 | |
| 338 | $last_upgrade_submenu_position = $this->get_submenu_item_count( 'paid-upgrades.php' ); |
| 339 | |
| 340 | add_submenu_page( 'paid-upgrades.php', __( 'Domains', 'jetpack' ), __( 'Domains', 'jetpack' ), 'manage_options', 'https://wordpress.com/domains/manage/' . $this->domain, null, $last_upgrade_submenu_position - 1 ); |
| 341 | |
| 342 | /** |
| 343 | * Whether to show the WordPress.com Emails submenu under the main Upgrades menu. |
| 344 | * |
| 345 | * @use add_filter( 'jetpack_show_wpcom_upgrades_email_menu', '__return_true' ); |
| 346 | * @module masterbar |
| 347 | * |
| 348 | * @since 9.7.0 |
| 349 | * |
| 350 | * @param bool $show_wpcom_upgrades_email_menu Load the WordPress.com Emails submenu item. Default to false. |
| 351 | */ |
| 352 | if ( apply_filters( 'jetpack_show_wpcom_upgrades_email_menu', false ) ) { |
| 353 | add_submenu_page( 'paid-upgrades.php', __( 'Emails', 'jetpack' ), __( 'Emails', 'jetpack' ), 'manage_options', 'https://wordpress.com/email/' . $this->domain, null, $last_upgrade_submenu_position ); |
| 354 | } |
| 355 | } |
| 356 | |
| 357 | /** |
| 358 | * Adds Settings menu. |
| 359 | */ |
| 360 | public function add_options_menu() { |
| 361 | parent::add_options_menu(); |
| 362 | |
| 363 | if ( Jetpack_Plan::supports( 'security-settings' ) ) { |
| 364 | add_submenu_page( |
| 365 | 'options-general.php', |
| 366 | esc_attr__( 'Security', 'jetpack' ), |
| 367 | __( 'Security', 'jetpack' ), |
| 368 | 'manage_options', |
| 369 | 'https://wordpress.com/settings/security/' . $this->domain, |
| 370 | null, |
| 371 | 2 |
| 372 | ); |
| 373 | } |
| 374 | |
| 375 | add_submenu_page( 'options-general.php', esc_attr__( 'Hosting Configuration', 'jetpack' ), __( 'Hosting Configuration', 'jetpack' ), 'manage_options', 'https://wordpress.com/hosting-config/' . $this->domain, null, 11 ); |
| 376 | |
| 377 | // Page Optimize is active by default on all Atomic sites and registers a Settings > Performance submenu which |
| 378 | // would conflict with our own Settings > Performance that links to Calypso, so we hide it it since the Calypso |
| 379 | // performance settings already have a link to Page Optimize settings page. |
| 380 | $this->hide_submenu_page( 'options-general.php', 'page-optimize' ); |
| 381 | } |
| 382 | |
| 383 | /** |
| 384 | * Adds Tools menu entries. |
| 385 | */ |
| 386 | public function add_tools_menu() { |
| 387 | parent::add_tools_menu(); |
| 388 | |
| 389 | /** |
| 390 | * Adds the WordPress.com Site Monitoring submenu under the main Tools menu. |
| 391 | */ |
| 392 | add_submenu_page( 'tools.php', esc_attr__( 'Site Monitoring', 'jetpack' ), __( 'Site Monitoring', 'jetpack' ), 'manage_options', 'https://wordpress.com/site-monitoring/' . $this->domain, null, 7 ); |
| 393 | } |
| 394 | |
| 395 | /** |
| 396 | * Override the global submenu_file for theme-install.php page so the WP Admin menu item gets highlighted correctly. |
| 397 | * |
| 398 | * @param string $submenu_file The current pages $submenu_file global variable value. |
| 399 | * @return string | null |
| 400 | */ |
| 401 | public function override_the_theme_installer( $submenu_file ) { |
| 402 | global $pagenow; |
| 403 | |
| 404 | if ( 'themes.php' === $submenu_file && 'theme-install.php' === $pagenow ) { |
| 405 | return null; |
| 406 | } |
| 407 | return $submenu_file; |
| 408 | } |
| 409 | |
| 410 | /** |
| 411 | * Also remove the Gutenberg plugin menu. |
| 412 | */ |
| 413 | public function remove_gutenberg_menu() { |
| 414 | // Always remove the Gutenberg menu. |
| 415 | remove_menu_page( 'gutenberg' ); |
| 416 | } |
| 417 | |
| 418 | /** |
| 419 | * Saves the sidebar state ( expanded / collapsed ) via an ajax request. |
| 420 | */ |
| 421 | public function ajax_sidebar_state() { |
| 422 | $expanded = isset( $_REQUEST['expanded'] ) ? filter_var( wp_unslash( $_REQUEST['expanded'] ), FILTER_VALIDATE_BOOLEAN ) : false; // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
| 423 | Client::wpcom_json_api_request_as_user( |
| 424 | '/me/preferences', |
| 425 | '2', |
| 426 | array( |
| 427 | 'method' => 'POST', |
| 428 | ), |
| 429 | (object) array( 'calypso_preferences' => (object) array( 'sidebarCollapsed' => ! $expanded ) ), |
| 430 | 'wpcom' |
| 431 | ); |
| 432 | |
| 433 | wp_die(); |
| 434 | } |
| 435 | |
| 436 | /** |
| 437 | * Handle ajax requests to dismiss a just-in-time-message |
| 438 | */ |
| 439 | public function wp_ajax_jitm_dismiss() { |
| 440 | check_ajax_referer( 'jitm_dismiss' ); |
| 441 | $jitm = \Automattic\Jetpack\JITMS\JITM::get_instance(); |
| 442 | if ( isset( $_REQUEST['id'] ) && isset( $_REQUEST['feature_class'] ) ) { |
| 443 | $jitm->dismiss( sanitize_text_field( wp_unslash( $_REQUEST['id'] ) ), sanitize_text_field( wp_unslash( $_REQUEST['feature_class'] ) ) ); |
| 444 | } |
| 445 | wp_die(); |
| 446 | } |
| 447 | } |
| 448 |