Merge branch 'maxwelljordanwhite-maxwelljordanwhite-patch-1'

Author: pattonwebz

README.md

@@ -18,15 +18,15 @@ This is a utility class that is intended to format your WordPress theme menu wit
 
 *This walker is fully compliant with all Theme Review guidelines for wordpress.org theme submission.* It requires no modification to be compliant but you can optionally replace the `wp-bootstrap-navwalker` text domain (which appears twice in the `fallback` function) with the text domain of your theme.
 
-### UPGRADE NOTES ###
+### Upgrade Notes
 
-Between version 3 and version 4 of the walker there have been significant changes to the codebase. Version 4 of the walker is built to work with Bootstrap 4 and has not been tested for backwards compatibility with Bootstrap 3. A separate branch for Bootstrap 3 is maintained here: https://github.com/wp-bootstrap/wp-bootstrap-navwalker/tree/v3-branch
+Between version 3 and version 4 of the walker there have been significant changes to the codebase. Version 4 of the walker is built to work with Bootstrap 4 and has not been tested for backwards compatibility with Bootstrap 3. A separate branch for Bootstrap 3 is maintained here: <https://github.com/wp-bootstrap/wp-bootstrap-navwalker/tree/v3-branch>
 
 Here is a list of the most notable changes:
 
 - The filename has been changed and prefixed with `class-` to better fit PHP coding standards naming conventions.
-	- New Name: `class-wp-bootstrap-navwalker.php`
-	- Old Name: `wp-bootstrap-navwalker.php`
+  - New Name: `class-wp-bootstrap-navwalker.php`
+  - Old Name: `wp-bootstrap-navwalker.php`
 - Icon and link modifier handling is now done through the `CSS Classes` menu item input instead of the `Title` input.
 - Icon only items are possible using icon classes in combination with the `sr-only` classname.
 
@@ -50,70 +50,71 @@ If you encounter errors with the above code use a check like this to return clea
 
 ```php
 if ( ! file_exists( get_template_directory() . '/class-wp-bootstrap-navwalker.php' ) ) {
-	// file does not exist... return an error.
-	return new WP_Error( 'class-wp-bootstrap-navwalker-missing', __( 'It appears the class-wp-bootstrap-navwalker.php file may be missing.', 'wp-bootstrap-navwalker' ) );
+    // File does not exist... return an error.
+    return new WP_Error( 'class-wp-bootstrap-navwalker-missing', __( 'It appears the class-wp-bootstrap-navwalker.php file may be missing.', 'wp-bootstrap-navwalker' ) );
 } else {
-	// file exists... require it.
-	require_once get_template_directory() . '/class-wp-bootstrap-navwalker.php';
+    // File exists... require it.
+    require_once get_template_directory() . '/class-wp-bootstrap-navwalker.php';
 }
 ```
+
 You will also need to declare a new menu in your `functions.php` file if one doesn't already exist.
 
 ```php
 register_nav_menus( array(
-	'primary' => __( 'Primary Menu', 'THEMENAME' ),
+    'primary' => __( 'Primary Menu', 'THEMENAME' ),
 ) );
 ```
+
 ## Usage
 
 Add or update any `wp_nav_menu()` functions in your theme (often found in `header.php`) to use the new walker by adding a `'walker'` item to the wp_nav_menu args array.
 
 ```php
 wp_nav_menu( array(
-	'theme_location'  => 'primary',
-	'depth'	          => 2, // 1 = no dropdowns, 2 = with dropdowns.
-	'container'       => 'div',
-	'container_class' => 'collapse navbar-collapse',
-	'container_id'    => 'bs-example-navbar-collapse-1',
-	'menu_class'      => 'navbar-nav mr-auto',
-	'fallback_cb'     => 'WP_Bootstrap_Navwalker::fallback',
-	'walker'          => new WP_Bootstrap_Navwalker(),
+    'theme_location'  => 'primary',
+    'depth'           => 2, // 1 = no dropdowns, 2 = with dropdowns.
+    'container'       => 'div',
+    'container_class' => 'collapse navbar-collapse',
+    'container_id'    => 'bs-example-navbar-collapse-1',
+    'menu_class'      => 'navbar-nav mr-auto',
+    'fallback_cb'     => 'WP_Bootstrap_Navwalker::fallback',
+    'walker'          => new WP_Bootstrap_Navwalker(),
 ) );
 ```
 
 Your menu will now be formatted with the correct syntax and classes to implement Bootstrap dropdown navigation.
 
-Typically the menu is wrapped with additional markup, here is an example of a ` fixed-top` menu that collapse for responsive navigation at the md breakpoint.
+Typically the menu is wrapped with additional markup, here is an example of a `fixed-top` menu that collapse for responsive navigation at the md breakpoint.
 
 ```php
 <nav class="navbar navbar-expand-md navbar-light bg-light" role="navigation">
   <div class="container">
-	<!-- Brand and toggle get grouped for better mobile display -->
-	<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-controls="bs-example-navbar-collapse-1" aria-expanded="false" aria-label="Toggle navigation">
-		<span class="navbar-toggler-icon"></span>
-	</button>
-	<a class="navbar-brand" href="#">Navbar</a>
-		<?php
-		wp_nav_menu( array(
-			'theme_location'    => 'primary',
-			'depth'             => 2,
-			'container'         => 'div',
-			'container_class'   => 'collapse navbar-collapse',
-			'container_id'      => 'bs-example-navbar-collapse-1',
-			'menu_class'        => 'nav navbar-nav',
-			'fallback_cb'       => 'WP_Bootstrap_Navwalker::fallback',
-			'walker'            => new WP_Bootstrap_Navwalker(),
-		) );
-		?>
-	</div>
+    <!-- Brand and toggle get grouped for better mobile display -->
+    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-controls="bs-example-navbar-collapse-1" aria-expanded="false" aria-label="Toggle navigation">
+        <span class="navbar-toggler-icon"></span>
+    </button>
+    <a class="navbar-brand" href="#">Navbar</a>
+        <?php
+        wp_nav_menu( array(
+            'theme_location'    => 'primary',
+            'depth'             => 2,
+            'container'         => 'div',
+            'container_class'   => 'collapse navbar-collapse',
+            'container_id'      => 'bs-example-navbar-collapse-1',
+            'menu_class'        => 'nav navbar-nav',
+            'fallback_cb'       => 'WP_Bootstrap_Navwalker::fallback',
+            'walker'            => new WP_Bootstrap_Navwalker(),
+        ) );
+        ?>
+    </div>
 </nav>
 ```
 
 To change your menu style add Bootstrap nav class names to the `menu_class` declaration.
 
 Review options in the Bootstrap docs for more information on [nav classes](https://getbootstrap.com/components/#nav).
 
-
 ### Displaying the Menu
 
 To display the menu you must associate your menu with your theme location. You can do this by selecting your theme location in the *Theme Locations* list while editing a menu in the WordPress menu manager.
@@ -124,12 +125,13 @@ There has been some interest in making this walker the default walker for all me
 
 ```php
 function prefix_modify_nav_menu_args( $args ) {
-	return array_merge( $args, array(
-		'walker' => WP_Bootstrap_Navwalker(),
-	) );
+    return array_merge( $args, array(
+        'walker' => WP_Bootstrap_Navwalker(),
+    ) );
 }
 add_filter( 'wp_nav_menu_args', 'prefix_modify_nav_menu_args' );
 ```
+
 Simply updating the walker may not be enough to get menus working right, you may need to add wrappers or additional classes, you can do that via the above function as well.
 
 ### Menu Caching
@@ -138,31 +140,32 @@ On some sites generating a large menu that rarely ever changes on every page req
 
 The biggest drawback to caching nav menus with this method is that it cannot easily apply the `.current-menu-item` or the `.active` class to the currently active item as WP decides what is currently active on page load - and since the menu is cached it only knows the active page that it was cached on originally.
 
-You can decide yourself if you want to put up with those drawbacks for the benefit of removing the menu generation time on most page loads. You can follow this article by Dave Clements to see how we cached nav menus that were generated by this walker: https://www.doitwithwp.com/use-transients-speed-wordpress-menus/
+You can decide yourself if you want to put up with those drawbacks for the benefit of removing the menu generation time on most page loads. You can follow this article by Dave Clements to see how we cached nav menus that were generated by this walker: <https://www.doitwithwp.com/use-transients-speed-wordpress-menus/>
 
 Be sure to set the `echo` argument to FALSE in `the wp_nav_menu()` call when doing this so that the results can be stored instead of echoed to the page.
 
 See also:
-- https://generatewp.com/how-to-use-transients-to-speed-up-wordpress-menus/
-- https://vip-svn.wordpress.com/plugins/cache-nav-menu/cache-nav-menu.php
+
+- <https://generatewp.com/how-to-use-transients-to-speed-up-wordpress-menus/>
+- <https://vip-svn.wordpress.com/plugins/cache-nav-menu/cache-nav-menu.php>
 
 ### Extras
 
 This script included the ability to use Bootstrap nav link mods in your menus through the WordPress menu UI. Disabled links, dropdown headers and dropdown dividers are supported. Additionally icon support is built-in for Glyphicons and Font Awesome (note: you will need to include the icon stylesheets or assets separately).
 
 #### Icons
 
-To add an Icon to your link simply enter Glypicons or Font Awesome class names in the links **CSS Classes** field in the Menu UI and the walker class will do the rest. IE `glyphicons glyphicons-bullhorn` or `fa fa-arrow-left` or `fas fa-arrow-left`.
+To add an Icon to your link simply enter Glyphicons or Font Awesome class names in the links **CSS Classes** field in the Menu UI and the walker class will do the rest. IE `glyphicons glyphicons-bullhorn` or `fa fa-arrow-left` or `fas fa-arrow-left`.
 
 #### Icon-Only Items
 
 To make an item appear with the icon only apply the bootstrap screen reader class `sr-only` to the item alongside any icon classnames. This will then hide only the text that would appear as the link text.
 
 #### Disabled Links
 
-To set a disabled link simply add `disabled` to the **CSS Classes** field in the Menu UI and the walker class will do the rest. _Note: In addition to adding the .disabled class this will change the link `href` to `#` as well so that it is not a followable link._
+To set a disabled link simply add `disabled` to the **CSS Classes** field in the Menu UI and the walker class will do the rest. _Note: In addition to adding the .disabled class this will change the link `href` to `#` as well so that it is not a follow-able link._
 
-#### Dropdown Headers, Dropdown Dividers & Dropdown Item Text.
+#### Dropdown Headers, Dropdown Dividers & Dropdown Item Text
 
 Headers, dividers and text only items can be added within dropdowns by adding a Custom Link and adding either `dropdown-header`, `dropdown-divider` or `dropdown-item-text` into the **CSS Classes** input. _Note: This will remove the `href` on the item and change it to either a `<span>` for headers or a `<div>` for dividers._