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:
1 | <?php |
||
15 | class Atomic_Admin_Menu extends Admin_Menu { |
||
16 | |||
17 | /** |
||
18 | * Atomic_Admin_Menu constructor. |
||
19 | */ |
||
20 | protected function __construct() { |
||
31 | |||
32 | /** |
||
33 | * Create the desired menu output. |
||
34 | */ |
||
35 | View Code Duplication | public function reregister_menu_items() { |
|
36 | parent::reregister_menu_items(); |
||
37 | |||
38 | $wp_admin = $this->should_link_to_wp_admin(); |
||
39 | |||
40 | $this->add_my_home_menu( $wp_admin ); |
||
41 | $this->add_theme_install_menu( $wp_admin ); |
||
42 | |||
43 | // Not needed outside of wp-admin. |
||
44 | if ( ! $this->is_api_request ) { |
||
45 | $this->add_browse_sites_link(); |
||
46 | $this->add_site_card_menu(); |
||
47 | $this->add_new_site_link(); |
||
48 | } |
||
49 | |||
50 | ksort( $GLOBALS['menu'] ); |
||
51 | } |
||
52 | |||
53 | /** |
||
54 | * Adds Plugins menu. |
||
55 | * |
||
56 | * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso). |
||
57 | */ |
||
58 | public function add_plugins_menu( $wp_admin = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
||
59 | // Plugins on Atomic sites are always managed on WP Admin. |
||
60 | parent::add_plugins_menu( true ); |
||
61 | } |
||
62 | |||
63 | /** |
||
64 | * Adds the site switcher link if user has more than one site. |
||
65 | */ |
||
66 | public function add_browse_sites_link() { |
||
67 | $site_count = get_user_option( 'wpcom_site_count' ); |
||
68 | if ( ! $site_count || $site_count < 2 ) { |
||
69 | return; |
||
70 | } |
||
71 | |||
72 | // Add the menu item. |
||
73 | add_menu_page( __( 'site-switcher', 'jetpack' ), __( 'Browse sites', 'jetpack' ), 'read', 'https://wordpress.com/home', null, 'dashicons-arrow-left-alt2', 0 ); |
||
74 | add_filter( 'add_menu_classes', array( $this, 'set_browse_sites_link_class' ) ); |
||
75 | } |
||
76 | |||
77 | /** |
||
78 | * Adds a custom element class for Site Switcher menu item. |
||
79 | * |
||
80 | * @param array $menu Associative array of administration menu items. |
||
81 | * @return array |
||
82 | */ |
||
83 | View Code Duplication | public function set_browse_sites_link_class( array $menu ) { |
|
84 | foreach ( $menu as $key => $menu_item ) { |
||
85 | if ( 'site-switcher' !== $menu_item[3] ) { |
||
86 | continue; |
||
87 | } |
||
88 | |||
89 | $menu[ $key ][4] = add_cssclass( 'site-switcher', $menu_item[4] ); |
||
90 | break; |
||
91 | } |
||
92 | |||
93 | return $menu; |
||
94 | } |
||
95 | |||
96 | /** |
||
97 | * Adds a link to the menu to create a new site. |
||
98 | */ |
||
99 | public function add_new_site_link() { |
||
100 | global $menu; |
||
101 | |||
102 | $site_count = get_user_option( 'wpcom_site_count' ); |
||
103 | if ( $site_count && $site_count > 1 ) { |
||
104 | return; |
||
105 | } |
||
106 | |||
107 | // Attempt to get last position. |
||
108 | $position = 1000; |
||
109 | while ( isset( $menu[ $position ] ) ) { |
||
110 | $position++; |
||
111 | } |
||
112 | |||
113 | $this->add_admin_menu_separator( ++$position ); |
||
114 | add_menu_page( __( 'Add new site', 'jetpack' ), __( 'Add new site', 'jetpack' ), 'read', 'https://wordpress.com/start?ref=calypso-sidebar', null, 'dashicons-plus-alt', ++$position ); |
||
115 | } |
||
116 | |||
117 | /** |
||
118 | * Adds site card component. |
||
119 | */ |
||
120 | public function add_site_card_menu() { |
||
121 | $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>' ); |
||
122 | $icon = get_site_icon_url( 32, $default ); |
||
123 | |||
124 | $badge = ''; |
||
125 | if ( function_exists( 'site_is_private' ) && site_is_private() ) { |
||
126 | $badge .= sprintf( |
||
127 | '<span class="site__badge site__badge-private">%s</span>', |
||
128 | site_is_coming_soon() ? esc_html__( 'Coming Soon', 'jetpack' ) : esc_html__( 'Private', 'jetpack' ) |
||
129 | ); |
||
130 | } |
||
131 | |||
132 | $site_card = ' |
||
133 | <div class="site__info"> |
||
134 | <div class="site__title">%1$s</div> |
||
135 | <div class="site__domain">%2$s</div> |
||
136 | %3$s |
||
137 | </div>'; |
||
138 | |||
139 | $site_card = sprintf( |
||
140 | $site_card, |
||
141 | get_option( 'blogname' ), |
||
142 | $this->domain, |
||
143 | $badge |
||
144 | ); |
||
145 | |||
146 | add_menu_page( 'site-card', $site_card, 'read', get_home_url(), null, $icon, 1 ); |
||
147 | add_filter( 'add_menu_classes', array( $this, 'set_site_card_menu_class' ) ); |
||
148 | } |
||
149 | |||
150 | /** |
||
151 | * Adds a custom element class and id for Site Card's menu item. |
||
152 | * |
||
153 | * @param array $menu Associative array of administration menu items. |
||
154 | * @return array |
||
155 | */ |
||
156 | public function set_site_card_menu_class( array $menu ) { |
||
157 | foreach ( $menu as $key => $menu_item ) { |
||
158 | if ( 'site-card' !== $menu_item[3] ) { |
||
159 | continue; |
||
160 | } |
||
161 | |||
162 | $classes = ' toplevel_page_site-card'; |
||
163 | |||
164 | // webclip.png is the default on WoA sites. Anything other than that means we have a custom site icon. |
||
165 | if ( has_site_icon() && 'https://s0.wp.com/i/webclip.png' !== get_site_icon_url( 512 ) ) { |
||
166 | $classes .= ' has-site-icon'; |
||
167 | } |
||
168 | |||
169 | $menu[ $key ][4] = $menu_item[4] . $classes; |
||
170 | $menu[ $key ][5] = 'toplevel_page_site_card'; |
||
171 | break; |
||
172 | } |
||
173 | |||
174 | return $menu; |
||
175 | } |
||
176 | |||
177 | /** |
||
178 | * Adds Upgrades menu. |
||
179 | */ |
||
180 | public function add_upgrades_menu() { |
||
181 | parent::add_upgrades_menu(); |
||
182 | |||
183 | add_submenu_page( 'https://wordpress.com/plans/' . $this->domain, __( 'Domains', 'jetpack' ), __( 'Domains', 'jetpack' ), 'manage_options', 'https://wordpress.com/domains/manage/' . $this->domain, null, 10 ); |
||
184 | } |
||
185 | |||
186 | /** |
||
187 | * Adds Tools menu. |
||
188 | * |
||
189 | * @param bool $wp_admin_import Optional. Whether Import link should point to Calypso or wp-admin. Default false (Calypso). |
||
190 | * @param bool $wp_admin_export Optional. Whether Export link should point to Calypso or wp-admin. Default false (Calypso). |
||
191 | */ |
||
192 | public function add_tools_menu( $wp_admin_import = false, $wp_admin_export = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
||
193 | // Export on Atomic sites is always handled on WP Admin. |
||
194 | parent::add_tools_menu( $wp_admin_import, true ); |
||
195 | } |
||
196 | |||
197 | /** |
||
198 | * Adds Settings menu. |
||
199 | * |
||
200 | * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso). |
||
201 | */ |
||
202 | public function add_options_menu( $wp_admin = false ) { |
||
207 | |||
208 | /** |
||
209 | * Adds a WordPress.org theme install menu item. |
||
210 | * |
||
211 | * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso). |
||
212 | */ |
||
213 | public function add_theme_install_menu( $wp_admin = false ) { |
||
214 | $parent_menu_slug = $wp_admin ? 'themes.php' : 'https://wordpress.com/themes/' . $this->domain; |
||
215 | |||
216 | add_submenu_page( $parent_menu_slug, esc_attr__( 'Add New Theme', 'jetpack' ), __( 'Add New Theme', 'jetpack' ), 'install_themes', 'theme-install.php', null, 1 ); |
||
218 | } |
||
219 |