This package provides an easy way to create custom routes (MVC), roles, Custom post types, ... using a config file.
composer require tombroucke/wp-sidewheels
dirname(__FILE__) is where your config.php file resides.
use Otomaties\Sidewheels\Sidewheels;
add_action('init', function(){
Sidewheels::init(dirname(__FILE__));
});use Otomaties\Sidewheels\Sidewheels;
register_activation_hook(__FILE__, function(){
Sidewheels::install(dirname(__FILE__));
});use Otomaties\Sidewheels\Sidewheels;
register_deactivation_hook(__FILE__, function(){
Sidewheels::uninstall();
});After adding new routes, you need to manually flush your rewrite rules.
<?php
use Namespace\Models\Order;
return [
'templatePath' => __DIR__ . '/views', // This is the default template directory, so this could be omitted
'textDomain' => 'plugin-textdomain', // Text domain for admin strings translation
'routes' => [
[
'path' => 'public-p
B84F
age',
'callback' => ['Namespace\Controllers\Frontend', 'index'], // Or string: 'Namespace\Controllers\Frontend@index'
'title' => __('Public page', 'plugin-textdomain'),
],
[
'path' => 'private-page',
'callback' => ['Namespace\Controllers\Admin', 'index'],
'title' => __('Private page', 'plugin-textdomain'),
'capability' => 'manage_my_plugin',
],
[
'path' => 'private-page',
'callback' => ['Namespace\Controllers\Admin', 'create'],
'capability' => 'manage_my_plugin',
'method' => 'POST',
],
[
'path' => 'private-page/orders/{order_id}',
'callback' => 'Namespaces\Controllers\Admin\Order@index',
'method' => 'GET',
'title' => __('Order #{order_id}', 'plugin-textdomain'),
],
[
'path' => 'private-page/orders/{order_id}/{order_item}',
'callback' => 'Namespaces\Controllers\Admin\OrderItem@index',
'method' => 'GET',
'title' => __('Order item #{order_item}', 'plugin-textdomain'),
]
],
'postTypes' => [ // See https://github.com/johnbillion/extended-cpts
'shop_order' => array(
'args' => array(
'labels' => array(
'singular_name' => __('Order', 'plugin-textdomain'),
'plural_name' => __('Orders', 'plugin-textdomain'),
),
'menu_icon' => 'dashicons-cart',
'supports' => array( 'title', 'author' ),
'show_in_menu' => true,
'public' => false,
'publicly_queryable' => false,
'has_archive' => false,
'admin_cols' => array(
'name' => array(
'title' => __('Name', 'plugin-textdomain'),
'meta_key' => 'name',
),
'total' => array(
'title' => __('Total', 'plugin-textdomain'),
'function' => function () {
$order = new Order(get_the_ID());
echo $order->total();
},
),
),
),
),
],
'roles' => [
'administrator' => array(
'label' => __('Administrator', 'plugin-textdomain'),
'capabilities' => array(
'manage_my_plugin' => true,
),
),
]
];For each route, you need to define a callback. This can be an inline function or a controller.
<?php
namespace Namespace\Controllers;
use Otomaties\Sidewheels\Abstracts\Controller;
class Admin extends Controller
{
public function index()
{
$this->route()->setTitle('Dashboard'); // Optional, only for rendering complete pages
$this->render('admin/dash.html', [ // render() : complete page, renderContent() : render during the_content(), renderShortcode() : returns html instead of rendering
'website' => 'https://tombroucke.be'
]);
}
public function create()
{
// Create a post or perform other action on POST
}
public function shout(string $string)
{
return strtoupper($string);
}
}This package uses twig as it's templating engine. You can pass variable to your templates, e.g. 'website'. The route object is also passed in as a variable, so you can use {{ route.title }} for example. You can call public methods from your controller.
<!DOCTYPE html>
<html lang="en">
<head>
<title>{{ route.title }}</title>
</head>
<body>
<h1>{{ route.title }}</h1>
<p>Check out this website: {{ website }}</p>
<p>{{ shout('I\'m shouting'); }}</p>
</body>
</html>By default, the very basic vendor/tombroucke/wp-sidewheels/templates/sidewheels.php template will be loaded for all endpoints. You can add a sidewheels.php template in your views directory, or in your theme root directory. You can use the sidewheels_template_paths filter to load a custom template based on a specific route or other logic.
use Namespace\Models\Order;
add_filter('sidewheels_user_has_access', function ($access, $route) {
if (current_user_can('manage_options')) {
$access = true;
}
// Only give access if current user is author of {order_id}
if ($route->path() == 'private-page/orders/{order_id}') {
$order = new Order($route->parameter('order_id'));
return $order->author() == get_current_user_id();
}
return $access;
}, 10, 2);Title can also be set from controller $this->route()->setTitle('title');, but this filter will override everything.
add_filter('sidewheels_route_title', function ($title, $route) {
if ($route->path() == 'public-page') {
$title = 'Custom public page title';
}
return $title;
}, 10, 2);use \Twig\TwigFunction;
add_filter('sidewheels_twig_functions', function ($functions) {
$functions = new TwigFunction(
'customFunction',
function ($argument) {
// Modify $argument
return $argument;
}
);
return $functions;
});You can add routes outside of the config file:
Route::get('public-page', 'Namespace\Controllers\Frontend@index');