|
| 1 | +# WP Force Lowercase URLs |
| 2 | + |
| 3 | +[](https://circleci.com/gh/ItinerisLtd/wp-force-lowercase-urls) |
| 4 | +[](https://packagist.org/packages/itinerisltd/wp-force-lowercase-urls) |
| 5 | +[](https://packagist.org/packages/itinerisltd/wp-force-lowercase-urls) |
| 6 | +[](https://packagist.org/packages/itinerisltd/wp-force-lowercase-urls/stats) |
| 7 | +[](https://github.com/ItinerisLtd/wp-force-lowercase-urls/blob/master/LICENSE) |
| 8 | +[](https://www.itineris.co.uk/contact/) |
| 9 | +[](https://twitter.com/itineris_ltd) |
| 10 | +[](https://twitter.com/_codepuncher) |
| 11 | + |
| 12 | +Force uppercase URLs to lowercase. |
| 13 | + |
| 14 | +<!-- START doctoc generated TOC please keep comment here to allow auto update --> |
| 15 | +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
| 16 | + |
| 17 | +- [Goal](#goal) |
| 18 | +- [Features](#features) |
| 19 | +- [Minimum Requirements](#minimum-requirements) |
| 20 | +- [Installation](#installation) |
| 21 | + - [Composer (Recommended)](#composer-recommended) |
| 22 | + - [Build from Source (Not Recommended)](#build-from-source-not-recommended) |
| 23 | +- [Common Issues](#common-issues) |
| 24 | +- [FAQ](#faq) |
| 25 | + - [Will you add support for older PHP versions?](#will-you-add-support-for-older-php-versions) |
| 26 | + - [It looks awesome. Where can I find more goodies like this?](#it-looks-awesome-where-can-i-find-more-goodies-like-this) |
| 27 | + - [Where can I give :star::star::star::star::star: reviews?](#where-can-i-give-starstarstarstarstar-reviews) |
| 28 | +- [Developing](#developing) |
| 29 | + - [Testing](#testing) |
| 30 | +- [Feedback](#feedback) |
| 31 | +- [Change Log](#change-log) |
| 32 | +- [Security](#security) |
| 33 | +- [Credits](#credits) |
| 34 | +- [License](#license) |
| 35 | + |
| 36 | +<!-- END doctoc generated TOC please keep comment here to allow auto update --> |
| 37 | + |
| 38 | +## Goal |
| 39 | + |
| 40 | +Prevent issues caused by pages existing on URLs of various casing. |
| 41 | + |
| 42 | +## Features |
| 43 | + |
| 44 | +- Forces URLs to lowercase |
| 45 | +- Ignores file URLs |
| 46 | + |
| 47 | +[Pull requests](https://github.com/ItinerisLtd/wp-force-lowercase-urls) are welcomed. |
| 48 | + |
| 49 | +## Minimum Requirements |
| 50 | + |
| 51 | +- PHP v7.4 |
| 52 | +- WordPress v5.8 |
| 53 | + |
| 54 | +## Installation |
| 55 | + |
| 56 | +### Composer (Recommended) |
| 57 | + |
| 58 | +```bash |
| 59 | +composer require itinerisltd/wp-force-lowercase-urls |
| 60 | +``` |
| 61 | + |
| 62 | +### Build from Source (Not Recommended) |
| 63 | + |
| 64 | +```bash |
| 65 | +# Make sure you use the same PHP version as remote servers. |
| 66 | +# Building inside docker images is recommended. |
| 67 | +php -v |
| 68 | + |
| 69 | +# Checkout source code |
| 70 | +git clone https://github.com/ItinerisLtd/wp-force-lowercase-urls.git |
| 71 | +cd wp-force-lowercase-urls |
| 72 | +git checkout <the-tag-or-the-branch-or-the-commit> |
| 73 | + |
| 74 | +# Build the zip file |
| 75 | +composer release:build |
| 76 | +``` |
| 77 | + |
| 78 | +Then, install `release/wp-force-lowercase-urls.zip` [as usual](https://codex.wordpress.org/Managing_Plugins#Installing_Plugins). |
| 79 | + |
| 80 | +## Common Issues |
| 81 | + |
| 82 | +N/A |
| 83 | + |
| 84 | +## FAQ |
| 85 | + |
| 86 | +### Will you add support for older PHP versions? |
| 87 | + |
| 88 | +Never! This plugin will only work on [actively supported PHP versions](https://secure.php.net/supported-versions.php). |
| 89 | + |
| 90 | +Don't use it on **end of life** or **security fixes only** PHP versions. |
| 91 | + |
| 92 | +### It looks awesome. Where can I find more goodies like this? |
| 93 | + |
| 94 | +- Articles on [Itineris' blog](https://www.itineris.co.uk/blog/) |
| 95 | +- More projects on [Itineris' GitHub profile](https://github.com/itinerisltd) |
| 96 | +- More plugins on [Itineris](https://profiles.wordpress.org/itinerisltd/#content-plugins) and [_codepuncher](https://profiles.wordpress.org/codepuncher/#content-plugins) wp.org profiles |
| 97 | +- Follow [@itineris_ltd](https://twitter.com/itineris_ltd) and [@_codepuncher](https://twitter.com/_codepuncher) on Twitter |
| 98 | +- Hire [Itineris](https://www.itineris.co.uk/services/) to build your next awesome site |
| 99 | + |
| 100 | +### Where can I give :star::star::star::star::star: reviews? |
| 101 | + |
| 102 | +Thanks! Glad you like it. It's important to let my boss knows somebody is using this project. Please consider: |
| 103 | + |
| 104 | +- leave a 5-star review on [wordpress.org](https://wordpress.org/support/plugin/wp-force-lowercase-urls/reviews/) |
| 105 | +- tweet something good with mentioning [@itineris_ltd](https://twitter.com/itineris_ltd) and [@_codepuncher](https://twitter.com/_codepuncher) |
| 106 | +- :star: star this [Github repo](https://github.com/ItinerisLtd/wp-force-lowercase-urls) |
| 107 | +- :eyes: watch this [Github repo](https://github.com/ItinerisLtd/wp-force-lowercase-urls) |
| 108 | +- write blog posts |
| 109 | +- submit [pull requests](https://github.com/ItinerisLtd/wp-force-lowercase-urls) |
| 110 | +- [hire Itineris](https://www.itineris.co.uk/services/) |
| 111 | + |
| 112 | +## Developing |
| 113 | + |
| 114 | +### Testing |
| 115 | + |
| 116 | +```bash |
| 117 | +composer style:check |
| 118 | +``` |
| 119 | + |
| 120 | +Pull requests without tests will not be accepted! |
| 121 | + |
| 122 | +## Feedback |
| 123 | + |
| 124 | +**Please provide feedback!** We want to make this library useful in as many projects as possible. |
| 125 | +Please submit an [issue](https://github.com/ItinerisLtd/wp-force-lowercase-urls/issues/new) and point out what you do and don't like, or fork the project and make suggestions. |
| 126 | +**No issue is too small.** |
| 127 | + |
| 128 | +## Change Log |
| 129 | + |
| 130 | +Please see [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently. |
| 131 | + |
| 132 | +## Security |
| 133 | + |
| 134 | +If you discover any security related issues, please email [[email protected]](mailto:[email protected]) instead of using the issue tracker. |
| 135 | + |
| 136 | +## Credits |
| 137 | + |
| 138 | +[wp-force-lowercase-urls](https://github.com/ItinerisLtd/wp-force-lowercase-urls) is a [Itineris Limited](https://www.itineris.co.uk/) project created by [Lee Hanbury-Pickett](https://github.com/codepuncher). |
| 139 | + |
| 140 | +Full list of contributors can be found [here](https://github.com/ItinerisLtd/wp-force-lowercase-urls/graphs/contributors). |
| 141 | + |
| 142 | +## License |
| 143 | + |
| 144 | +[WP Force Lowercase URLs](https://github.com/ItinerisLtd/wp-force-lowercase-urls) is released under the [MIT License](https://opensource.org/licenses/MIT). |
0 commit comments