Skip to content

Commit 1773f72

Browse files
committed
Add upgrade note highlighting notable changes for people moving from v3 to v4 of the walker
1 parent 80f65b6 commit 1773f72

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,18 @@ A custom WordPress Nav Walker Class to fully implement the Bootstrap 4 navigatio
1414

1515
This is a utility class that is intended to format your WordPress theme menu with the correct syntax and CSS classes to utilize the Bootstrap dropdown navigation. It does not include the required Bootstrap JS and CSS files - you will have to include them manually.
1616

17+
### UPGRADE NOTES ###
18+
19+
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
20+
21+
Here is a list of the most notable changes:
22+
23+
- The filename has been changed and prefixed with `class-` to better fit PHP coding standards naming conventions.
24+
- New Name: `class-wp-bootstrap-navwalker.php`
25+
- Old Name: `wp-bootstrap-navwalker.php`
26+
- Icon and link modifier handling is now done through the `CSS Classes` menu item input instead of the `Title` input.
27+
- Icon only items are possible using icon classes in combination with the `sr-only` classname.
28+
1729
## Installation
1830

1931
Place **class-wp-bootstrap-navwalker.php** in your WordPress theme folder `/wp-content/your-theme/`

0 commit comments

Comments
 (0)