Completed
Pull Request — master (#446)
by
unknown
01:48
created

WP_Bootstrap_Navwalker::fallback()   C

Complexity

Conditions 12
Paths 97

Size

Total Lines 47

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 47
rs 6.9666
c 0
b 0
f 0
cc 12
nc 97
nop 1

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * WP Bootstrap Navwalker
4
 *
5
 * @package WP-Bootstrap-Navwalker
6
 *
7
 * @wordpress-plugin
8
 * Plugin Name: WP Bootstrap Navwalker
9
 * Plugin URI:  https://github.com/wp-bootstrap/wp-bootstrap-navwalker
10
 * Description: A custom WordPress nav walker class to implement the Bootstrap 4 navigation style in a custom theme using the WordPress built in menu manager.
11
 * Author: Edward McIntyre - @twittem, WP Bootstrap, William Patton - @pattonwebz
12
 * Version: 4.3.0
13
 * Author URI: https://github.com/wp-bootstrap
14
 * GitHub Plugin URI: https://github.com/wp-bootstrap/wp-bootstrap-navwalker
15
 * GitHub Branch: master
16
 * License: GPL-3.0+
17
 * License URI: http://www.gnu.org/licenses/gpl-3.0.txt
18
 */
19
20
// Check if Class Exists.
21
if ( ! class_exists( 'WP_Bootstrap_Navwalker' ) ) :
22
	/**
23
	 * WP_Bootstrap_Navwalker class.
24
	 */
25
	class WP_Bootstrap_Navwalker extends Walker_Nav_Menu {
26
27
		/**
28
		 * Whether the items_wrap contains schema microdata or not.
29
		 *
30
		 * @since 4.2.0
31
		 * @var boolean
32
		 */
33
		private $has_schema = false;
34
35
		/**
36
		 * Ensure the items_wrap argument contains microdata.
37
		 *
38
		 * @since 4.2.0
39
		 */
40
		public function __construct() {
41
			if ( ! has_filter( 'wp_nav_menu_args', array( $this, 'add_schema_to_navbar_ul' ) ) ) {
42
				add_filter( 'wp_nav_menu_args', array( $this, 'add_schema_to_navbar_ul' ) );
43
			}
44
		}
45
46
		/**
47
		 * Starts the list before the elements are added.
48
		 *
49
		 * @since WP 3.0.0
50
		 *
51
		 * @see Walker_Nav_Menu::start_lvl()
52
		 *
53
		 * @param string           $output Used to append additional content (passed by reference).
54
		 * @param int              $depth  Depth of menu item. Used for padding.
55
		 * @param WP_Nav_Menu_Args $args   An object of wp_nav_menu() arguments.
56
		 */
57
		public function start_lvl( &$output, $depth = 0, $args = null ) {
58 View Code Duplication
			if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
59
				$t = '';
60
				$n = '';
61
			} else {
62
				$t = "\t";
63
				$n = "\n";
64
			}
65
			$indent = str_repeat( $t, $depth );
66
			// Default class to add to the file.
67
			$classes = array( 'dropdown-menu' );
68
			/**
69
			 * Filters the CSS class(es) applied to a menu list element.
70
			 *
71
			 * @since WP 4.8.0
72
			 *
73
			 * @param array    $classes The CSS classes that are applied to the menu `<ul>` element.
74
			 * @param stdClass $args    An object of `wp_nav_menu()` arguments.
75
			 * @param int      $depth   Depth of menu item. Used for padding.
76
			 */
77
			$class_names = join( ' ', apply_filters( 'nav_menu_submenu_css_class', $classes, $args, $depth ) );
78
			$class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : '';
79
80
			/*
81
			 * The `.dropdown-menu` container needs to have a labelledby
82
			 * attribute which points to it's trigger link.
83
			 *
84
			 * Form a string for the labelledby attribute from the the latest
85
			 * link with an id that was added to the $output.
86
			 */
87
			$labelledby = '';
88
			// Find all links with an id in the output.
89
			preg_match_all( '/(<a.*?id=\"|\')(.*?)\"|\'.*?>/im', $output, $matches );
90
			// With pointer at end of array check if we got an ID match.
91
			if ( end( $matches[2] ) ) {
92
				// Build a string to use as aria-labelledby.
93
				$labelledby = 'aria-labelledby="' . esc_attr( end( $matches[2] ) ) . '"';
94
			}
95
			$output .= "{$n}{$indent}<ul$class_names $labelledby role=\"menu\">{$n}";
96
		}
97
98
		/**
99
		 * Starts the element output.
100
		 *
101
		 * @since WP 3.0.0
102
		 * @since WP 4.4.0 The {@see 'nav_menu_item_args'} filter was added.
103
		 *
104
		 * @see Walker_Nav_Menu::start_el()
105
		 *
106
		 * @param string           $output Used to append additional content (passed by reference).
107
		 * @param WP_Nav_Menu_Item $item   Menu item data object.
108
		 * @param int              $depth  Depth of menu item. Used for padding.
109
		 * @param WP_Nav_Menu_Args $args   An object of wp_nav_menu() arguments.
110
		 * @param int              $id     Current item ID.
111
		 */
112
		public function start_el( &$output, $item, $depth = 0, $args = null, $id = 0 ) {
113 View Code Duplication
			if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
114
				$t = '';
115
				$n = '';
0 ignored issues
show
Unused Code introduced by
$n is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
116
			} else {
117
				$t = "\t";
118
				$n = "\n";
0 ignored issues
show
Unused Code introduced by
$n is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
119
			}
120
			$indent = ( $depth ) ? str_repeat( $t, $depth ) : '';
121
122
			if ( false !== strpos( $args->items_wrap, 'itemscope' ) && false === $this->has_schema ) {
123
				$this->has_schema  = true;
124
				$args->link_before = '<span itemprop="name">' . $args->link_before;
125
				$args->link_after .= '</span>';
126
			}
127
128
			$classes = empty( $item->classes ) ? array() : (array) $item->classes;
129
130
			/*
131
			 * Initialize some holder variables to store specially handled item
132
			 * wrappers and icons.
133
			 */
134
			$linkmod_classes = array();
135
			$icon_classes    = array();
136
137
			/*
138
			 * Get an updated $classes array without linkmod or icon classes.
139
			 *
140
			 * NOTE: linkmod and icon class arrays are passed by reference and
141
			 * are maybe modified before being used later in this function.
142
			 */
143
			$classes = self::separate_linkmods_and_icons_from_classes( $classes, $linkmod_classes, $icon_classes, $depth );
144
145
			// Join any icon classes plucked from $classes into a string.
146
			$icon_class_string = join( ' ', $icon_classes );
147
148
			/**
149
			 * Filters the arguments for a single nav menu item.
150
			 *
151
			 * @since WP 4.4.0
152
			 *
153
			 * @param WP_Nav_Menu_Args $args  An object of wp_nav_menu() arguments.
154
			 * @param WP_Nav_Menu_Item $item  Menu item data object.
155
			 * @param int              $depth Depth of menu item. Used for padding.
156
			 *
157
			 * @var WP_Nav_Menu_Args
158
			 */
159
			$args = apply_filters( 'nav_menu_item_args', $args, $item, $depth );
160
161
			// Add .dropdown or .active classes where they are needed.
162
			if ( $this->has_children ) {
163
				$classes[] = 'dropdown';
164
			}
165
			if ( in_array( 'current-menu-item', $classes, true ) || in_array( 'current-menu-parent', $classes, true ) ) {
166
				$classes[] = 'active';
167
			}
168
169
			// Add some additional default classes to the item.
170
			$classes[] = 'menu-item-' . $item->ID;
171
			$classes[] = 'nav-item';
172
173
			// Allow filtering the classes.
174
			$classes = apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args, $depth );
175
176
			// Form a string of classes in format: class="class_names".
177
			$class_names = join( ' ', $classes );
178
			$class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : '';
179
180
			/**
181
			 * Filters the ID applied to a menu item's list item element.
182
			 *
183
			 * @since WP 3.0.1
184
			 * @since WP 4.1.0 The `$depth` parameter was added.
185
			 *
186
			 * @param string           $menu_id The ID that is applied to the menu item's `<li>` element.
187
			 * @param WP_Nav_Menu_Item $item    The current menu item.
188
			 * @param WP_Nav_Menu_Args $args    An object of wp_nav_menu() arguments.
189
			 * @param int              $depth   Depth of menu item. Used for padding.
190
			 */
191
			$id = apply_filters( 'nav_menu_item_id', 'menu-item-' . $item->ID, $item, $args, $depth );
192
			$id = $id ? ' id="' . esc_attr( $id ) . '"' : '';
193
194
			$output .= $indent . '<li ' . $id . $class_names . '>';
195
196
			// Initialize array for holding the $atts for the link item.
197
			$atts = array();
198
199
			$atts['title']  = ! empty( $item->attr_title ) ? $item->attr_title : '';
200
201
			$atts['target'] = ! empty( $item->target ) ? $item->target : '';
202
203
			if ( '_blank' === $item->target && empty( $item->xfn ) ) {
204
				$atts['rel'] = 'noopener noreferrer';
205
			} else {
206
				$atts['rel'] = ! empty( $item->xfn ) ? $item->xfn : '';
207
			}
208
209
			// If the item has_children add atts to <a>.
210
			if ( $args->has_children && 0 === $depth && $args->depth > 1 ) {
211
				$atts['href']          = '#';
212
				$atts['data-toggle']   = 'dropdown';
213
				$atts['aria-haspopup'] = 'true';
214
				$atts['aria-expanded'] = 'false';
215
				$atts['class']         = 'dropdown-toggle nav-link';
216
				$atts['id']            = 'menu-item-dropdown-' . $item->ID;
217
			} else {
218
				if ( true === $this->has_schema ) {
219
					$atts['itemprop'] = 'url';
220
				}
221
222
				$atts['href'] = ! empty( $item->url ) ? $item->url : '#';
223
				// For items in dropdowns use .dropdown-item instead of .nav-link.
224
				if ( $depth > 0 ) {
225
					$atts['class'] = 'dropdown-item';
226
				} else {
227
					$atts['class'] = 'nav-link';
228
				}
229
			}
230
231
			$atts['aria-current'] = $item->current ? 'page' : '';
232
233
			// Update atts of this item based on any custom linkmod classes.
234
			$atts = self::update_atts_for_linkmod_type( $atts, $linkmod_classes );
235
236
			// Allow filtering of the $atts array before using it.
237
			$atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args, $depth );
238
239
			// Build a string of html containing all the atts for the item.
240
			$attributes = '';
241
			foreach ( $atts as $attr => $value ) {
242
				if ( ! empty( $value ) ) {
243
					$value       = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
244
					$attributes .= ' ' . $attr . '="' . $value . '"';
245
				}
246
			}
247
248
			// Set a typeflag to easily test if this is a linkmod or not.
249
			$linkmod_type = self::get_linkmod_type( $linkmod_classes );
250
251
			// START appending the internal item contents to the output.
252
			$item_output = isset( $args->before ) ? $args->before : '';
253
254
			/*
255
			 * This is the start of the internal nav item. Depending on what
256
			 * kind of linkmod we have we may need different wrapper elements.
257
			 */
258
			if ( '' !== $linkmod_type ) {
259
				// Is linkmod, output the required element opener.
260
				$item_output .= self::linkmod_element_open( $linkmod_type, $attributes );
261
			} else {
262
				// With no link mod type set this must be a standard <a> tag.
263
				$item_output .= '<a' . $attributes . '>';
264
			}
265
266
			/*
267
			 * Initiate empty icon var, then if we have a string containing any
268
			 * icon classes form the icon markup with an <i> element. This is
269
			 * output inside of the item before the $title (the link text).
270
			 */
271
			$icon_html = '';
272
			if ( ! empty( $icon_class_string ) ) {
273
				// Append an <i> with the icon classes to what is output before links.
274
				$icon_html = '<i class="' . esc_attr( $icon_class_string ) . '" aria-hidden="true"></i> ';
275
			}
276
277
			/** This filter is documented in wp-includes/post-template.php */
278
			$title = apply_filters( 'the_title', esc_html( $item->title ), $item->ID );
279
280
			/**
281
			 * Filters a menu item's title.
282
			 *
283
			 * @since WP 4.4.0
284
			 *
285
			 * @param string           $title The menu item's title.
286
			 * @param WP_Nav_Menu_Item $item  The current menu item.
287
			 * @param WP_Nav_Menu_Args $args  An object of wp_nav_menu() arguments.
288
			 * @param int              $depth Depth of menu item. Used for padding.
289
			 */
290
			$title = apply_filters( 'nav_menu_item_title', $title, $item, $args, $depth );
291
292
			// If the .sr-only class was set apply to the nav items text only.
293
			if ( in_array( 'sr-only', $linkmod_classes, true ) ) {
294
				$title         = self::wrap_for_screen_reader( $title );
295
				$keys_to_unset = array_keys( $linkmod_classes, 'sr-only', true );
296
				foreach ( $keys_to_unset as $k ) {
297
					unset( $linkmod_classes[ $k ] );
298
				}
299
			}
300
301
			// Put the item contents into $output.
302
			$item_output .= isset( $args->link_before ) ? $args->link_before . $icon_html . $title . $args->link_after : '';
303
304
			/*
305
			 * This is the end of the internal nav item. We need to close the
306
			 * correct element depending on the type of link or link mod.
307
			 */
308
			if ( '' !== $linkmod_type ) {
309
				// Is linkmod, output the required closing element.
310
				$item_output .= self::linkmod_element_close( $linkmod_type );
311
			} else {
312
				// With no link mod type set this must be a standard <a> tag.
313
				$item_output .= '</a>';
314
			}
315
316
			$item_output .= isset( $args->after ) ? $args->after : '';
317
318
			// END appending the internal item contents to the output.
319
			$output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
320
		}
321
322
		/**
323
		 * Menu fallback.
324
		 *
325
		 * If this function is assigned to the wp_nav_menu's fallback_cb variable
326
		 * and a menu has not been assigned to the theme location in the WordPress
327
		 * menu manager the function will display nothing to a non-logged in user,
328
		 * and will add a link to the WordPress menu manager if logged in as an admin.
329
		 *
330
		 * @param array $args passed from the wp_nav_menu function.
331
		 * @return string|void String when echo is false.
332
		 */
333
		public static function fallback( $args ) {
334
			if ( ! current_user_can( 'edit_theme_options' ) ) {
335
				return;
336
			}
337
338
			// Initialize var to store fallback html.
339
			$fallback_output = '';
340
341
			// Menu container opening tag.
342
			$show_container = false;
343
			if ( $args['container'] ) {
344
				/**
345
				 * Filters the list of HTML tags that are valid for use as menu containers.
346
				 *
347
				 * @since WP 3.0.0
348
				 *
349
				 * @param array $tags The acceptable HTML tags for use as menu containers.
350
				 *                    Default is array containing 'div' and 'nav'.
351
				 */
352
				$allowed_tags = apply_filters( 'wp_nav_menu_container_allowedtags', array( 'div', 'nav' ) );
353
				if ( is_string( $args['container'] ) && in_array( $args['container'], $allowed_tags, true ) ) {
354
					$show_container   = true;
355
					$class            = $args['container_class'] ? ' class="menu-fallback-container ' . esc_attr( $args['container_class'] ) . '"' : ' class="menu-fallback-container"';
356
					$id               = $args['container_id'] ? ' id="' . esc_attr( $args['container_id'] ) . '"' : '';
357
					$fallback_output .= '<' . $args['container'] . $id . $class . '>';
358
				}
359
			}
360
361
			// The fallback menu.
362
			$class            = $args['menu_class'] ? ' class="menu-fallback-menu ' . esc_attr( $args['menu_class'] ) . '"' : ' class="menu-fallback-menu"';
363
			$id               = $args['menu_id'] ? ' id="' . esc_attr( $args['menu_id'] ) . '"' : '';
364
			$fallback_output .= '<ul' . $id . $class . '>';
365
			$fallback_output .= '<li class="nav-item"><a href="' . esc_url( admin_url( 'nav-menus.php' ) ) . '" class="nav-link" title="' . esc_attr__( 'Add a menu', 'wp-bootstrap-navwalker' ) . '">' . esc_html__( 'Add a menu', 'wp-bootstrap-navwalker' ) . '</a></li>';
366
			$fallback_output .= '</ul>';
367
368
			// Menu container closing tag.
369
			if ( $show_container ) {
370
				$fallback_output .= '</' . $args['container'] . '>';
371
			}
372
373
			// if $args has 'echo' key and it's true echo, otherwise return.
374
			if ( array_key_exists( 'echo', $args ) && $args['echo'] ) {
375
				echo $fallback_output; // WPCS: XSS OK.
376
			} else {
377
				return $fallback_output;
378
			}
379
		}
380
381
		/**
382
		 * Filter to ensure the items_Wrap argument contains microdata.
383
		 *
384
		 * @since 4.2.0
385
		 *
386
		 * @param  array $args The nav instance arguments.
387
		 * @return array $args The altered nav instance arguments.
388
		 */
389
		public function add_schema_to_navbar_ul( $args ) {
390
			$wrap = $args['items_wrap'];
391
			if ( strpos( $wrap, 'SiteNavigationElement' ) === false ) {
392
				$args['items_wrap'] = preg_replace( '/(>).*>?\%3\$s/', ' itemscope itemtype="http://www.schema.org/SiteNavigationElement"$0', $wrap );
393
			}
394
395
			return $args;
396
		}
397
398
		/**
399
		 * Find any custom linkmod or icon classes and store in their holder
400
		 * arrays then remove them from the main classes array.
401
		 *
402
		 * Supported linkmods: .disabled, .dropdown-header, .dropdown-divider, .sr-only
403
		 * Supported iconsets: Font Awesome 4/5, Glypicons
404
		 *
405
		 * NOTE: This accepts the linkmod and icon arrays by reference.
406
		 *
407
		 * @since 4.0.0
408
		 *
409
		 * @param array   $classes         an array of classes currently assigned to the item.
410
		 * @param array   $linkmod_classes an array to hold linkmod classes.
411
		 * @param array   $icon_classes    an array to hold icon classes.
412
		 * @param integer $depth           an integer holding current depth level.
413
		 *
414
		 * @return array  $classes         a maybe modified array of classnames.
415
		 */
416
		private function separate_linkmods_and_icons_from_classes( $classes, &$linkmod_classes, &$icon_classes, $depth ) {
417
			// Loop through $classes array to find linkmod or icon classes.
418
			foreach ( $classes as $key => $class ) {
419
				/*
420
				 * If any special classes are found, store the class in it's
421
				 * holder array and and unset the item from $classes.
422
				 */
423
				if ( preg_match( '/^disabled|^sr-only/i', $class ) ) {
424
					// Test for .disabled or .sr-only classes.
425
					$linkmod_classes[] = $class;
426
					unset( $classes[ $key ] );
427
				} elseif ( preg_match( '/^dropdown-header|^dropdown-divider|^dropdown-item-text/i', $class ) && $depth > 0 ) {
428
					/*
429
					 * Test for .dropdown-header or .dropdown-divider and a
430
					 * depth greater than 0 - IE inside a dropdown.
431
					 */
432
					$linkmod_classes[] = $class;
433
					unset( $classes[ $key ] );
434
				} elseif ( preg_match( '/^fa-(\S*)?|^fa(s|r|l|b)?(\s?)?$/i', $class ) ) {
435
					// Font Awesome.
436
					$icon_classes[] = $class;
437
					unset( $classes[ $key ] );
438
				} elseif ( preg_match( '/^glyphicon-(\S*)?|^glyphicon(\s?)$/i', $class ) ) {
439
					// Glyphicons.
440
					$icon_classes[] = $class;
441
					unset( $classes[ $key ] );
442
				}
443
			}
444
445
			return $classes;
446
		}
447
448
		/**
449
		 * Return a string containing a linkmod type and update $atts array
450
		 * accordingly depending on the decided.
451
		 *
452
		 * @since 4.0.0
453
		 *
454
		 * @param array $linkmod_classes array of any link modifier classes.
455
		 *
456
		 * @return string                empty for default, a linkmod type string otherwise.
457
		 */
458
		private function get_linkmod_type( $linkmod_classes = array() ) {
459
			$linkmod_type = '';
460
			// Loop through array of linkmod classes to handle their $atts.
461
			if ( ! empty( $linkmod_classes ) ) {
462
				foreach ( $linkmod_classes as $link_class ) {
463
					if ( ! empty( $link_class ) ) {
464
465
						// Check for special class types and set a flag for them.
466
						if ( 'dropdown-header' === $link_class ) {
467
							$linkmod_type = 'dropdown-header';
468
						} elseif ( 'dropdown-divider' === $link_class ) {
469
							$linkmod_type = 'dropdown-divider';
470
						} elseif ( 'dropdown-item-text' === $link_class ) {
471
							$linkmod_type = 'dropdown-item-text';
472
						}
473
					}
474
				}
475
			}
476
			return $linkmod_type;
477
		}
478
479
		/**
480
		 * Update the attributes of a nav item depending on the limkmod classes.
481
		 *
482
		 * @since 4.0.0
483
		 *
484
		 * @param array $atts            array of atts for the current link in nav item.
485
		 * @param array $linkmod_classes an array of classes that modify link or nav item behaviors or displays.
486
		 *
487
		 * @return array                 maybe updated array of attributes for item.
488
		 */
489
		private function update_atts_for_linkmod_type( $atts = array(), $linkmod_classes = array() ) {
490
			if ( ! empty( $linkmod_classes ) ) {
491
				foreach ( $linkmod_classes as $link_class ) {
492
					if ( ! empty( $link_class ) ) {
493
						/*
494
						 * Update $atts with a space and the extra classname
495
						 * so long as it's not a sr-only class.
496
						 */
497
						if ( 'sr-only' !== $link_class ) {
498
							$atts['class'] .= ' ' . esc_attr( $link_class );
499
						}
500
						// Check for special class types we need additional handling for.
501
						if ( 'disabled' === $link_class ) {
502
							// Convert link to '#' and unset open targets.
503
							$atts['href'] = '#';
504
							unset( $atts['target'] );
505
						} elseif ( 'dropdown-header' === $link_class || 'dropdown-divider' === $link_class || 'dropdown-item-text' === $link_class ) {
506
							// Store a type flag and unset href and target.
507
							unset( $atts['href'] );
508
							unset( $atts['target'] );
509
						}
510
					}
511
				}
512
			}
513
			return $atts;
514
		}
515
516
		/**
517
		 * Wraps the passed text in a screen reader only class.
518
		 *
519
		 * @since 4.0.0
520
		 *
521
		 * @param string $text the string of text to be wrapped in a screen reader class.
522
		 * @return string      the string wrapped in a span with the class.
523
		 */
524
		private function wrap_for_screen_reader( $text = '' ) {
525
			if ( $text ) {
526
				$text = '<span class="sr-only">' . $text . '</span>';
527
			}
528
			return $text;
529
		}
530
531
		/**
532
		 * Returns the correct opening element and attributes for a linkmod.
533
		 *
534
		 * @since 4.0.0
535
		 *
536
		 * @param string $linkmod_type a sting containing a linkmod type flag.
537
		 * @param string $attributes   a string of attributes to add to the element.
538
		 *
539
		 * @return string              a string with the openign tag for the element with attribibutes added.
540
		 */
541
		private function linkmod_element_open( $linkmod_type, $attributes = '' ) {
542
			$output = '';
543
			if ( 'dropdown-item-text' === $linkmod_type ) {
544
				$output .= '<span class="dropdown-item-text"' . $attributes . '>';
545
			} elseif ( 'dropdown-header' === $linkmod_type ) {
546
				/*
547
				 * For a header use a span with the .h6 class instead of a real
548
				 * header tag so that it doesn't confuse screen readers.
549
				 */
550
				$output .= '<span class="dropdown-header h6"' . $attributes . '>';
551
			} elseif ( 'dropdown-divider' === $linkmod_type ) {
552
				// This is a divider.
553
				$output .= '<div class="dropdown-divider"' . $attributes . '>';
554
			}
555
			return $output;
556
		}
557
558
		/**
559
		 * Return the correct closing tag for the linkmod element.
560
		 *
561
		 * @since 4.0.0
562
		 *
563
		 * @param string $linkmod_type a string containing a special linkmod type.
564
		 *
565
		 * @return string              a string with the closing tag for this linkmod type.
566
		 */
567
		private function linkmod_element_close( $linkmod_type ) {
568
			$output = '';
569
			if ( 'dropdown-header' === $linkmod_type || 'dropdown-item-text' === $linkmod_type ) {
570
				/*
571
				 * For a header use a span with the .h6 class instead of a real
572
				 * header tag so that it doesn't confuse screen readers.
573
				 */
574
				$output .= '</span>';
575
			} elseif ( 'dropdown-divider' === $linkmod_type ) {
576
				// This is a divider.
577
				$output .= '</div>';
578
			}
579
			return $output;
580
		}
581
	}
582
endif;
583