Routes

A plugin often needs a page of its own. Without a route, the only way to reach one is the raw dispatcher URL:

https://example.com/index.php?page=custom&file=your_plugin/page.php

which is ugly and exposes your file layout. Routes turn that into:

https://example.com/your-plugin-page

Registering a route

osc_add_route($id, $regexp, $url, $file);

Parameter	Meaning
$id	Short name you will use to build the URL later.
$regexp	Regular expression the incoming path must match.
$url	Pattern used to build the pretty URL, with {parameters}.
$file	The PHP file to load when it matches.

Register routes early — on init or at the top of your plugin’s index.php — so they exist before the request is dispatched.

Building the URL

Never hard-code the path. Ask for it, so a change to the pattern does not break every link:

osc_route_url($id, $args = array());        // public site
osc_route_admin_url($id, $args = array());  // admin panel

A worked example

// Register — in your plugin's index.php
osc_add_route(
    'dynamic-route',                                  // id
    'dynamic-route/([0-9]+)/(.+)',                    // regexp
    'dynamic-route/{my-numeric-param}/{my-own-param}', // url pattern
    osc_plugin_folder(__FILE__) . 'mydynamicroute.php' // file
);

// Link to it — anywhere in a theme or plugin
echo osc_route_url('dynamic-route', array(
    'my-numeric-param' => '12345',
    'my-own-param'     => 'my-own-value',
));
// → https://example.com/dynamic-route/12345/my-own-value

Inside mydynamicroute.php, read the captured groups with Params::getParam().

Rules worth remembering

• Parameters in $url go between braces: {parameter}.
• Parameter names must match exactly, case included, between osc_add_route and osc_route_url.
• Any file in a folder called admin is opened in the admin panel and returns 404 on the public site.

Make your patterns unique

Regular expressions collide easily, and a greedy pattern can swallow core URLs — listings, categories, user pages. Prefix your routes with something specific to your plugin, and test that listings still resolve after you add one.

Controller routes

For an endpoint that acts and redirects rather than rendering a page — a form target, a webhook receiver, a “mark as sold” link — use a route hook instead:

osc_add_route_hook($id, $regexp, $url);

Unlike a file-backed route, this runs its handler without first emitting the theme’s custom.php chrome, so you can redirect or return a response without half a page already sent. Link to it with osc_route_url($id) exactly as before.