Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joanrodas/plubo-routes
Create custom WordPress routes and redirects, restrict access by roles and/or capabilities. Routes made simple
https://github.com/joanrodas/plubo-routes
composer composer-package plugin rewrite-rules routes routing wordpress wordpress-php-library wordpress-plugin
Last synced: 5 days ago
JSON representation
Create custom WordPress routes and redirects, restrict access by roles and/or capabilities. Routes made simple
- Host: GitHub
- URL: https://github.com/joanrodas/plubo-routes
- Owner: joanrodas
- License: gpl-3.0
- Created: 2022-04-06T17:22:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-06T13:00:23.000Z (about 1 month ago)
- Last Synced: 2024-10-06T13:19:09.657Z (about 1 month ago)
- Topics: composer, composer-package, plugin, rewrite-rules, routes, routing, wordpress, wordpress-php-library, wordpress-plugin
- Language: PHP
- Homepage: https://plubo.dev
- Size: 254 KB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/joanrodas/plubo-routes/stargazers)
WordPress routes made simple.
✔️ No need to write rewrite rules and tags manually\
✔️ Automatically flush rewrite rules when the routes change\
✔️ Custom redirects and action routes\
✔️ Easily extendable with hooks\
✔️ Easy to use with Sage 10
## Getting started
`composer require joanrodas/plubo-routes`
> You can also install Plubo Routes as a standalone WordPress plugin, simply downloading the zip and placing it in the plugins folder.
[Read the Docs](https://www.plubo.dev/docs/routing/)
## Adding new routes
There are different types of routes:
- [Route (template)](https://www.plubo.dev/docs/routing/)
- [RedirectRoute](https://www.plubo.dev/docs/routing/redirect-routes.html)
- [ActionRoute](https://www.plubo.dev/docs/routing/action-routes.html)
- [PageRoute](https://www.plubo.dev/docs/routing/page-routes.html)
## How to add a new route
You can add new routes using the following filter:
```php
PluboRoutes\RoutesProcessor::init();
add_filter( 'plubo/routes', array($this, 'add_routes') );
public function add_routes( $routes ) {
//Your routes
return $routes;
}
```
## Basic routes
Basic routes take 3 parameters:
| Parameter | Type |
| ------------- | ------------- |
| **Route Path** | String |
| **Template file name** | String \| Callable |
| **Config** | Array (optional) |
Examples:
```php
use PluboRoutes\Route\Route;
add_filter( 'plubo/routes', array($this, 'add_routes') );
public function add_routes( $routes ) {
$routes[] = new Route('clients/list', 'template_name');
//SAGE 10 example
$routes[] = new Route(
'dashboard/{subpage:slug}',
function($matches) {
$subpage = 'dashboard/' . $matches['subpage'];
return locate_template( app('sage.finder')->locate($subpage) );
},
[
'name' => 'my-route'
]
);
return $routes;
}
```
## Available syntax
You can use the format ***{variable_name:type}*** with any of the available types:
* number (numbers only)
* word (a-Z only)
* slug (a valid WordPress slug)
* date (yyyy-mm-dd date)
* year (4 digits)
* month (01-12)
* day (01-31)
* digit (single digit 0-9)
* jwt (JWT token)
* ip (IPv4)
> You can also use custom regex patterns using the format ***{variable_name:regex_pattern}*** like ***{author:([a-z0-9-]+)}***
## Changing general template path
By default, Plubo Routes will search the template inside your theme, but you can use a hook to chenge the default path.
If you use Sage 10, you could add something like this:
```php
add_filter( 'plubo/template', function($template) {
return app('sage.finder')->locate($template);
});
```
## Custom Actions
Named routes provide a hook to execute your custom actions:
```php
add_action('plubo/route_{route_name}', function($matches) {
//Do something
});
```
## Contributions
[](https://github.com/joanrodas/plubo-routes/issues)
[](https://github.com/joanrodas/plubo-routes/issues)
[](https://github.com/joanrodas/plubo-routes/blob/main/LICENSE)
Feel free to contribute to the project, suggesting improvements, reporting bugs and coding.