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:
Complex classes like WP_Bootstrap_Navwalker 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 WP_Bootstrap_Navwalker, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
29 | class WP_Bootstrap_Navwalker extends Walker_Nav_Menu { |
||
|
|||
30 | |||
31 | /** |
||
32 | * Starts the list before the elements are added. |
||
33 | * |
||
34 | * @since WP 3.0.0 |
||
35 | * |
||
36 | * @see Walker_Nav_Menu::start_lvl() |
||
37 | * |
||
38 | * @param string $output Used to append additional content (passed by reference). |
||
39 | * @param int $depth Depth of menu item. Used for padding. |
||
40 | * @param stdClass $args An object of wp_nav_menu() arguments. |
||
41 | */ |
||
42 | public function start_lvl( &$output, $depth = 0, $args = array() ) { |
||
81 | |||
82 | /** |
||
83 | * Starts the element output. |
||
84 | * |
||
85 | * @since WP 3.0.0 |
||
86 | * @since WP 4.4.0 The {@see 'nav_menu_item_args'} filter was added. |
||
87 | * |
||
88 | * @see Walker_Nav_Menu::start_el() |
||
89 | * |
||
90 | * @param string $output Used to append additional content (passed by reference). |
||
91 | * @param WP_Post $item Menu item data object. |
||
92 | * @param int $depth Depth of menu item. Used for padding. |
||
93 | * @param stdClass $args An object of wp_nav_menu() arguments. |
||
94 | * @param int $id Current item ID. |
||
95 | */ |
||
96 | public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) { |
||
97 | View Code Duplication | if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) { |
|
98 | $t = ''; |
||
99 | $n = ''; |
||
100 | } else { |
||
101 | $t = "\t"; |
||
102 | $n = "\n"; |
||
103 | } |
||
104 | $indent = ( $depth ) ? str_repeat( $t, $depth ) : ''; |
||
105 | |||
106 | $classes = empty( $item->classes ) ? array() : (array) $item->classes; |
||
107 | |||
108 | // Initialize some holder variables to store specially handled item |
||
109 | // wrappers and icons. |
||
110 | $linkmod_classes = array(); |
||
111 | $icon_classes = array(); |
||
112 | |||
113 | /** |
||
114 | * Get an updated $classes array without linkmod or icon classes. |
||
115 | * |
||
116 | * NOTE: linkmod and icon class arrays are passed by reference and |
||
117 | * are maybe modified before being used later in this function. |
||
118 | */ |
||
119 | $classes = self::seporate_linkmods_and_icons_from_classes( $classes, $linkmod_classes, $icon_classes, $depth ); |
||
120 | |||
121 | // Join any icon classes plucked from $classes into a string. |
||
122 | $icon_class_string = join( ' ', $icon_classes ); |
||
123 | |||
124 | /** |
||
125 | * Filters the arguments for a single nav menu item. |
||
126 | * |
||
127 | * WP 4.4.0 |
||
128 | * |
||
129 | * @param stdClass $args An object of wp_nav_menu() arguments. |
||
130 | * @param WP_Post $item Menu item data object. |
||
131 | * @param int $depth Depth of menu item. Used for padding. |
||
132 | */ |
||
133 | $args = apply_filters( 'nav_menu_item_args', $args, $item, $depth ); |
||
134 | |||
135 | // Add .dropdown or .active classes where they are needed. |
||
136 | if ( isset( $args->has_children ) && $args->has_children ) { |
||
137 | $classes[] = 'dropdown'; |
||
138 | } |
||
139 | if ( in_array( 'current-menu-item', $classes, true ) || in_array( 'current-menu-parent', $classes, true ) ) { |
||
140 | $classes[] = 'active'; |
||
141 | } |
||
142 | |||
143 | // Add some additional default classes to the item. |
||
144 | $classes[] = 'menu-item-' . $item->ID; |
||
145 | $classes[] = 'nav-item'; |
||
146 | |||
147 | // Allow filtering the classes. |
||
148 | $classes = apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args, $depth ); |
||
149 | |||
150 | // Form a string of classes in format: class="class_names". |
||
151 | $class_names = join( ' ', $classes ); |
||
152 | $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : ''; |
||
153 | |||
154 | /** |
||
155 | * Filters the ID applied to a menu item's list item element. |
||
156 | * |
||
157 | * @since WP 3.0.1 |
||
158 | * @since WP 4.1.0 The `$depth` parameter was added. |
||
159 | * |
||
160 | * @param string $menu_id The ID that is applied to the menu item's `<li>` element. |
||
161 | * @param WP_Post $item The current menu item. |
||
162 | * @param stdClass $args An object of wp_nav_menu() arguments. |
||
163 | * @param int $depth Depth of menu item. Used for padding. |
||
164 | */ |
||
165 | $id = apply_filters( 'nav_menu_item_id', 'menu-item-' . $item->ID, $item, $args, $depth ); |
||
166 | $id = $id ? ' id="' . esc_attr( $id ) . '"' : ''; |
||
167 | |||
168 | $output .= $indent . '<li itemscope="itemscope" itemtype="https://www.schema.org/SiteNavigationElement"' . $id . $class_names . '>'; |
||
169 | |||
170 | // initialize array for holding the $atts for the link item. |
||
171 | $atts = array(); |
||
172 | |||
173 | // Set title from item to the $atts array - if title is empty then |
||
174 | // default to item title. |
||
175 | if ( empty( $item->attr_title ) ) { |
||
176 | $atts['title'] = ! empty( $item->title ) ? strip_tags( $item->title ) : ''; |
||
177 | } else { |
||
178 | $atts['title'] = $item->attr_title; |
||
179 | } |
||
180 | |||
181 | $atts['target'] = ! empty( $item->target ) ? $item->target : ''; |
||
182 | $atts['rel'] = ! empty( $item->xfn ) ? $item->xfn : ''; |
||
183 | // If item has_children add atts to <a>. |
||
184 | if ( isset( $args->has_children ) && $args->has_children && 0 === $depth && $args->depth > 1 ) { |
||
185 | $atts['href'] = '#'; |
||
186 | $atts['data-toggle'] = 'dropdown'; |
||
187 | $atts['aria-haspopup'] = 'true'; |
||
188 | $atts['aria-expanded'] = 'false'; |
||
189 | $atts['class'] = 'dropdown-toggle nav-link'; |
||
190 | $atts['id'] = 'menu-item-dropdown-' . $item->ID; |
||
191 | } else { |
||
192 | $atts['href'] = ! empty( $item->url ) ? $item->url : '#'; |
||
193 | // Items in dropdowns use .dropdown-item instead of .nav-link. |
||
194 | if ( $depth > 0 ) { |
||
195 | $atts['class'] = 'dropdown-item'; |
||
196 | } else { |
||
197 | $atts['class'] = 'nav-link'; |
||
198 | } |
||
199 | } |
||
200 | |||
201 | // update atts of this item based on any custom linkmod classes. |
||
202 | $atts = self::update_atts_for_linkmod_type( $atts, $linkmod_classes ); |
||
203 | // Allow filtering of the $atts array before using it. |
||
204 | $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args, $depth ); |
||
205 | |||
206 | // Build a string of html containing all the atts for the item. |
||
207 | $attributes = ''; |
||
208 | foreach ( $atts as $attr => $value ) { |
||
209 | if ( ! empty( $value ) ) { |
||
210 | $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value ); |
||
211 | $attributes .= ' ' . $attr . '="' . $value . '"'; |
||
212 | } |
||
213 | } |
||
214 | |||
215 | /** |
||
216 | * Set a typeflag to easily test if this is a linkmod or not. |
||
217 | */ |
||
218 | $linkmod_type = self::get_linkmod_type( $linkmod_classes ); |
||
219 | |||
220 | /** |
||
221 | * START appending the internal item contents to the output. |
||
222 | */ |
||
223 | $item_output = isset( $args->before ) ? $args->before : ''; |
||
224 | /** |
||
225 | * This is the start of the internal nav item. Depending on what |
||
226 | * kind of linkmod we have we may need different wrapper elements. |
||
227 | */ |
||
228 | if ( '' !== $linkmod_type ) { |
||
229 | // is linkmod, output the required element opener. |
||
230 | $item_output .= self::linkmod_element_open( $linkmod_type, $attributes ); |
||
231 | } else { |
||
232 | // With no link mod type set this must be a standard <a> tag. |
||
233 | $item_output .= '<a' . $attributes . '>'; |
||
234 | } |
||
235 | |||
236 | /** |
||
237 | * Initiate empty icon var, then if we have a string containing any |
||
238 | * icon classes form the icon markup with an <i> element. This is |
||
239 | * output inside of the item before the $title (the link text). |
||
240 | */ |
||
241 | $icon_html = ''; |
||
242 | if ( ! empty( $icon_class_string ) ) { |
||
243 | // append an <i> with the icon classes to what is output before links. |
||
244 | $icon_html = '<i class="' . esc_attr( $icon_class_string ) . '" aria-hidden="true"></i> '; |
||
245 | } |
||
246 | |||
247 | /** This filter is documented in wp-includes/post-template.php */ |
||
248 | $title = apply_filters( 'the_title', $item->title, $item->ID ); |
||
249 | |||
250 | /** |
||
251 | * Filters a menu item's title. |
||
252 | * |
||
253 | * @since WP 4.4.0 |
||
254 | * |
||
255 | * @param string $title The menu item's title. |
||
256 | * @param WP_Post $item The current menu item. |
||
257 | * @param stdClass $args An object of wp_nav_menu() arguments. |
||
258 | * @param int $depth Depth of menu item. Used for padding. |
||
259 | */ |
||
260 | $title = apply_filters( 'nav_menu_item_title', $title, $item, $args, $depth ); |
||
261 | |||
262 | /** |
||
263 | * If the .sr-only class was set apply to the nav items text only. |
||
264 | */ |
||
265 | if ( in_array( 'sr-only', $linkmod_classes, true ) ) { |
||
266 | $title = self::wrap_for_screen_reader( $title ); |
||
267 | $keys_to_unset = array_keys( $linkmod_classes, 'sr-only' ); |
||
268 | foreach ( $keys_to_unset as $k ) { |
||
269 | unset( $linkmod_classes[ $k ] ); |
||
270 | } |
||
271 | } |
||
272 | |||
273 | // Put the item contents into $output. |
||
274 | $item_output .= isset( $args->link_before ) ? $args->link_before . $icon_html . $title . $args->link_after : ''; |
||
275 | /** |
||
276 | * This is the end of the internal nav item. We need to close the |
||
277 | * correct element depending on the type of link or link mod. |
||
278 | */ |
||
279 | if ( '' !== $linkmod_type ) { |
||
280 | // is linkmod, output the required element opener. |
||
281 | $item_output .= self::linkmod_element_close( $linkmod_type, $attributes ); |
||
282 | } else { |
||
283 | // With no link mod type set this must be a standard <a> tag. |
||
284 | $item_output .= '</a>'; |
||
285 | } |
||
286 | |||
287 | $item_output .= isset( $args->after ) ? $args->after : ''; |
||
288 | |||
289 | /** |
||
290 | * END appending the internal item contents to the output. |
||
291 | */ |
||
292 | $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args ); |
||
293 | |||
294 | } |
||
295 | |||
296 | /** |
||
297 | * Traverse elements to create list from elements. |
||
298 | * |
||
299 | * Display one element if the element doesn't have any children otherwise, |
||
300 | * display the element and its children. Will only traverse up to the max |
||
301 | * depth and no ignore elements under that depth. It is possible to set the |
||
302 | * max depth to include all depths, see walk() method. |
||
303 | * |
||
304 | * This method should not be called directly, use the walk() method instead. |
||
305 | * |
||
306 | * @since WP 2.5.0 |
||
307 | * |
||
308 | * @see Walker::start_lvl() |
||
309 | * |
||
310 | * @param object $element Data object. |
||
311 | * @param array $children_elements List of elements to continue traversing (passed by reference). |
||
312 | * @param int $max_depth Max depth to traverse. |
||
313 | * @param int $depth Depth of current element. |
||
314 | * @param array $args An array of arguments. |
||
315 | * @param string $output Used to append additional content (passed by reference). |
||
316 | */ |
||
317 | public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) { |
||
318 | if ( ! $element ) { |
||
319 | return; } |
||
320 | $id_field = $this->db_fields['id']; |
||
321 | // Display this element. |
||
322 | if ( is_object( $args[0] ) ) { |
||
323 | $args[0]->has_children = ! empty( $children_elements[ $element->$id_field ] ); } |
||
324 | parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output ); |
||
325 | } |
||
326 | |||
327 | /** |
||
328 | * Menu Fallback |
||
329 | * ============= |
||
330 | * If this function is assigned to the wp_nav_menu's fallback_cb variable |
||
331 | * and a menu has not been assigned to the theme location in the WordPress |
||
332 | * menu manager the function with display nothing to a non-logged in user, |
||
333 | * and will add a link to the WordPress menu manager if logged in as an admin. |
||
334 | * |
||
335 | * @param array $args passed from the wp_nav_menu function. |
||
336 | */ |
||
337 | public static function fallback( $args ) { |
||
338 | if ( current_user_can( 'edit_theme_options' ) ) { |
||
339 | |||
340 | /* Get Arguments. */ |
||
341 | $container = $args['container']; |
||
342 | $container_id = $args['container_id']; |
||
343 | $container_class = $args['container_class']; |
||
344 | $menu_class = $args['menu_class']; |
||
345 | $menu_id = $args['menu_id']; |
||
346 | |||
347 | // initialize var to store fallback html. |
||
348 | $fallback_output = ''; |
||
349 | |||
350 | if ( $container ) { |
||
351 | $fallback_output .= '<' . esc_attr( $container ); |
||
352 | if ( $container_id ) { |
||
353 | $fallback_output .= ' id="' . esc_attr( $container_id ) . '"'; |
||
354 | } |
||
355 | if ( $container_class ) { |
||
356 | $fallback_output .= ' class="' . esc_attr( $container_class ) . '"'; |
||
357 | } |
||
358 | $fallback_output .= '>'; |
||
359 | } |
||
360 | $fallback_output .= '<ul'; |
||
361 | if ( $menu_id ) { |
||
362 | $fallback_output .= ' id="' . esc_attr( $menu_id ) . '"'; } |
||
363 | if ( $menu_class ) { |
||
364 | $fallback_output .= ' class="' . esc_attr( $menu_class ) . '"'; } |
||
365 | $fallback_output .= '>'; |
||
366 | $fallback_output .= '<li><a href="' . esc_url( admin_url( 'nav-menus.php' ) ) . '" title="' . esc_attr__( 'Add a menu', 'wp-bootstrap-navwalker' ) . '">' . esc_html__( 'Add a menu', 'wp-bootstrap-navwalker' ) . '</a></li>'; |
||
367 | $fallback_output .= '</ul>'; |
||
368 | if ( $container ) { |
||
369 | $fallback_output .= '</' . esc_attr( $container ) . '>'; |
||
370 | } |
||
371 | |||
372 | // if $args has 'echo' key and it's true echo, otherwise return. |
||
373 | if ( array_key_exists( 'echo', $args ) && $args['echo'] ) { |
||
374 | echo $fallback_output; // WPCS: XSS OK. |
||
375 | } else { |
||
376 | return $fallback_output; |
||
377 | } |
||
378 | } |
||
379 | } |
||
380 | |||
381 | /** |
||
382 | * Find any custom linkmod or icon classes and store in their holder |
||
383 | * arrays then remove them from the main classes array. |
||
384 | * |
||
385 | * Supported linkmods: .disabled, .dropdown-header, .dropdown-divider, .sr-only |
||
386 | * Supported iconsets: Font Awesome 4/5, Glypicons |
||
387 | * |
||
388 | * NOTE: This accepts the linkmod and icon arrays by reference. |
||
389 | * |
||
390 | * @since 4.0.0 |
||
391 | * |
||
392 | * @param array $classes an array of classes currently assigned to the item. |
||
393 | * @param array $linkmod_classes an array to hold linkmod classes. |
||
394 | * @param array $icon_classes an array to hold icon classes. |
||
395 | * @param integer $depth an integer holding current depth level. |
||
396 | * |
||
397 | * @return array $classes a maybe modified array of classnames. |
||
398 | */ |
||
399 | private function seporate_linkmods_and_icons_from_classes( $classes, &$linkmod_classes, &$icon_classes, $depth ) { |
||
400 | // Loop through $classes array to find linkmod or icon classes. |
||
401 | foreach ( $classes as $key => $class ) { |
||
402 | // If any special classes are found, store the class in it's |
||
403 | // holder array and and unset the item from $classes. |
||
404 | if ( preg_match( '/^disabled|^sr-only/i', $class ) ) { |
||
405 | // Test for .disabled or .sr-only classes. |
||
406 | $linkmod_classes[] = $class; |
||
407 | unset( $classes[ $key ] ); |
||
408 | } elseif ( preg_match( '/^dropdown-header|^dropdown-divider|^dropdown-item-text/i', $class ) && $depth > 0 ) { |
||
409 | // Test for .dropdown-header or .dropdown-divider and a |
||
410 | // depth greater than 0 - IE inside a dropdown. |
||
411 | $linkmod_classes[] = $class; |
||
412 | unset( $classes[ $key ] ); |
||
413 | } elseif ( preg_match( '/^fa-(\S*)?|^fa(s|r|l|b)?(\s?)?$/i', $class ) ) { |
||
414 | // Font Awesome. |
||
415 | $icon_classes[] = $class; |
||
416 | unset( $classes[ $key ] ); |
||
417 | } elseif ( preg_match( '/^glyphicon-(\S*)?|^glyphicon(\s?)$/i', $class ) ) { |
||
418 | // Glyphicons. |
||
419 | $icon_classes[] = $class; |
||
420 | unset( $classes[ $key ] ); |
||
421 | } |
||
422 | } |
||
423 | |||
424 | return $classes; |
||
425 | } |
||
426 | |||
427 | /** |
||
428 | * Return a string containing a linkmod type and update $atts array |
||
429 | * accordingly depending on the decided. |
||
430 | * |
||
431 | * @since 4.0.0 |
||
432 | * |
||
433 | * @param array $linkmod_classes array of any link modifier classes. |
||
434 | * |
||
435 | * @return string empty for default, a linkmod type string otherwise. |
||
436 | */ |
||
437 | private function get_linkmod_type( $linkmod_classes = array() ) { |
||
438 | $linkmod_type = ''; |
||
439 | // Loop through array of linkmod classes to handle their $atts. |
||
440 | if ( ! empty( $linkmod_classes ) ) { |
||
441 | foreach ( $linkmod_classes as $link_class ) { |
||
442 | if ( ! empty( $link_class ) ) { |
||
443 | |||
444 | // check for special class types and set a flag for them. |
||
445 | if ( 'dropdown-header' === $link_class ) { |
||
446 | $linkmod_type = 'dropdown-header'; |
||
447 | } elseif ( 'dropdown-divider' === $link_class ) { |
||
448 | $linkmod_type = 'dropdown-divider'; |
||
449 | } elseif ( 'dropdown-item-text' === $link_class ) { |
||
450 | $linkmod_type = 'dropdown-item-text'; |
||
451 | } |
||
452 | } |
||
453 | } |
||
454 | } |
||
455 | return $linkmod_type; |
||
456 | } |
||
457 | |||
458 | /** |
||
459 | * Update the attributes of a nav item depending on the limkmod classes. |
||
460 | * |
||
461 | * @since 4.0.0 |
||
462 | * |
||
463 | * @param array $atts array of atts for the current link in nav item. |
||
464 | * @param array $linkmod_classes an array of classes that modify link or nav item behaviors or displays. |
||
465 | * |
||
466 | * @return array maybe updated array of attributes for item. |
||
467 | */ |
||
468 | private function update_atts_for_linkmod_type( $atts = array(), $linkmod_classes = array() ) { |
||
469 | if ( ! empty( $linkmod_classes ) ) { |
||
470 | foreach ( $linkmod_classes as $link_class ) { |
||
471 | if ( ! empty( $link_class ) ) { |
||
472 | // update $atts with a space and the extra classname... |
||
473 | // so long as it's not a sr-only class. |
||
474 | if ( 'sr-only' !== $link_class ) { |
||
475 | $atts['class'] .= ' ' . esc_attr( $link_class ); |
||
476 | } |
||
477 | // check for special class types we need additional handling for. |
||
478 | if ( 'disabled' === $link_class ) { |
||
479 | // Convert link to '#' and unset open targets. |
||
480 | $atts['href'] = '#'; |
||
481 | unset( $atts['target'] ); |
||
482 | } elseif ( 'dropdown-header' === $link_class || 'dropdown-divider' === $link_class || 'dropdown-item-text' === $link_class ) { |
||
483 | // Store a type flag and unset href and target. |
||
484 | unset( $atts['href'] ); |
||
485 | unset( $atts['target'] ); |
||
486 | } |
||
487 | } |
||
488 | } |
||
489 | } |
||
490 | return $atts; |
||
491 | } |
||
492 | |||
493 | /** |
||
494 | * Wraps the passed text in a screen reader only class. |
||
495 | * |
||
496 | * @since 4.0.0 |
||
497 | * |
||
498 | * @param string $text the string of text to be wrapped in a screen reader class. |
||
499 | * @return string the string wrapped in a span with the class. |
||
500 | */ |
||
501 | private function wrap_for_screen_reader( $text = '' ) { |
||
507 | |||
508 | /** |
||
509 | * Returns the correct opening element and attributes for a linkmod. |
||
510 | * |
||
511 | * @since 4.0.0 |
||
512 | * |
||
513 | * @param string $linkmod_type a sting containing a linkmod type flag. |
||
514 | * @param string $attributes a string of attributes to add to the element. |
||
515 | * |
||
516 | * @return string a string with the openign tag for the element with attribibutes added. |
||
517 | */ |
||
518 | private function linkmod_element_open( $linkmod_type, $attributes = '' ) { |
||
532 | |||
533 | /** |
||
534 | * Return the correct closing tag for the linkmod element. |
||
535 | * |
||
536 | * @since 4.0.0 |
||
537 | * |
||
538 | * @param string $linkmod_type a string containing a special linkmod type. |
||
539 | * |
||
540 | * @return string a string with the closing tag for this linkmod type. |
||
541 | */ |
||
542 | private function linkmod_element_close( $linkmod_type ) { |
||
554 | } |
||
555 | } |
||
556 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.