Provides a simple API for mapping requests to callback functions.

Jonathan Brinley

WordPress’s rewrite rules and query variables provide a powerful system 
for mapping URL strings to collections of posts. Every request is parsed 
into query variables and turned into a SQL query via <code>$wp_query->query()</code>.
Sometimes, though, you don’t want to display a list of posts. You just want 
a URL to map to a callback function, with the output displayed in place of 
posts in whatever theme you happen to be using.
That’s where WP Router comes in. It handles all the messy bits of registering 
post types, query variables, rewrite rules, etc., and lets you write code to 
do what you want it to do. One function call is all it takes to map a 
URL to your designated callback function and display the return value in the page.
Created by <a href="http://flightless.us" rel="nofollow ugc">Flightless</a>
<h3>Usage</h3>
<h4>Creating Routes</h4>
<ul>
<li>Your plugin should hook into the <code>wp_router_generate_routes</code> action. 
The callback should take one argument, a <code>WP_Router</code> object.</li>
<li>
Register a route and its callback using <code>WP_Router::add_route( $id, $args )</code>
<ul>
<li><code>$id</code> is a unique string your plugin should use to identify the route</li>
<li>
<code>$args</code> is an associative array, that sets the following properties for your route. 
Any omitted argument will use the default value.
<ul>
<li>
<code>path</code> (required) – A regular expression to match against the request path. 
This corresponds to the array key you would use when creating rewrite rules for WordPress.
</li>
<li>
<code>query_vars</code> – An associative array, with the keys being query vars, and the 
values being explicit strings or integers corresponding to matches in the path regexp. 
 Any query variables included here will be automatically registered.
</li>
<li>
<code>title</code> – The title of the page.
</li>
<li>
<code>title_callback</code> – A callback to use for dynamically generating the title. 
Defaults to <code>__()</code>. If <code>NULL</code>, the <code>title</code> argument will be used as-is. if 
 page_callback or <code>access_callback</code> returns <code>FALSE</code>, <code>title_callback</code> will not be called.
<pre><code>title_callback can be either a single callback function or an array specifying
</code></pre>
callback functions for specific HTTP methods (e.g., <code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>DELETE</code>, etc.). 
If the latter, the <code>default</code> key will be used if no other keys match the current 
request method.
</li>
<li>
<code>title_arguments</code> – An array of query variables whose values will be passed 
as arguments to <code>title_callback</code>. Defaults to the value of <code>title</code>. If an argument 
is not a registered query variable, it will be passed as-is.
</li>
<li>
<code>page_callback</code> (required) – A callback to use for dynamically generating the 
contents of the page. The callback should either echo or return the contents of 
the page (if both, the returned value will be appended to the echoed value). If 
 FALSE is returned, nothing will be output, and control of the page contents will 
be handed back to WordPress. The callback will be called during the <code>parse_request</code> 
phase of WordPress’s page load. If <code>access_callback</code> returns <code>FALSE</code>, <code>page_callback</code> 
will not be called.
<pre><code>page_callback can be either a single callback function or an array specifying
</code></pre>
callback functions for specific HTTP methods (e.g., <code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>DELETE</code>, etc.). 
If the latter, the <code>default</code> key will be used if no other keys match the current 
request method.
</li>
<li>
<code>page_arguments</code> – An array of query variables whose values will be passed as 
arguments to <code>page_callback</code>. If an argument is not a registered query variable, 
it will be passed as-is.
</li>
<li>
<code>access_callback</code> – A callback to determine if the user has permission to access 
this page. If <code>access_arguments</code> is provided, default is <code>current_user_can</code>, otherwise 
default is <code>TRUE</code>. If the callback returns <code>FALSE</code>, anonymous users are redirected to 
the login page, authenticated users get a 403 error.
<pre><code>access_callback can be either a single callback function or an array specifying
</code></pre>
callback functions for specific HTTP methods (e.g., <code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>DELETE</code>, etc.). 
If the latter, the <code>default</code> key will be used if no other keys match the current 
request method.
</li>
<li>
<code>access_arguments</code> – An array of query variables whose values will be passed 
as arguments to <code>access_callback</code>. If an argument is not a registered query variable, 
it will be passed as-is.
</li>
<li>
<code>template</code> – An array of templates that can be used to display the page. If a path 
is absolute, it will be used as-is; relative paths allow for overrides by the theme. 
The string <code>$id</code> will be replaced with the ID of the route. If no template is found, 
fallback templates are (in this order): <code>route-$id.php</code>, <code>route.php</code>, <code>page-$id.php</code>, 
 page.php, <code>index.php</code>. If FALSE is given instead of an array, the page contents will 
be printed before calling <code>exit()</code> (you can also accomplish this by printing your output 
and exiting directly from your callback function).
</li>
</ul>
</li>
</ul>
</li>
</ul>
Example: 
 $router->add_route(‘wp-router-sample’, array( 
 ‘path’ => ‘^wp_router/(.*?)$’, 
 ‘query_vars’ => array( 
 ‘sample_argument’ => 1, 
 ), 
 ‘page_callback’ => array(get_class(), ‘sample_callback’), 
 ‘page_arguments’ => array(‘sample_argument’), 
 ‘access_callback’ => TRUE, 
 ‘title’ => ‘WP Router Sample Page’, 
 ‘template’ => array(‘sample-page.php’, dirname(FILE).DIRECTORY_SEPARATOR.’sample-page.php’) 
 ));
In this example, the path <code>http://example.com/wp_router/my_sample_path/</code> will call 
the function <code>sample_callback</code> in the calling class. The value of the <code>sample_argument</code> 
query variable, in this case “my_sample_path”, will be provided as the first and only 
argument to the callback function. If the file <code>sample-page.php</code> is found in the theme, 
it will be used as the template, otherwise <code>sample-page.php</code> in your plugin directory will 
be used (if that’s not found either, fall back to <code>route-wp-router-sample.php</code>, etc.).
<h4>Editing Routes</h4>
<ul>
<li>You can hook into the <code>wp_router_alter_routes</code> action to modify routes created by other plugins. The callback should take one argument, a <code>WP_Router</code> object.</li>
</ul>
<h4>Public API Functions</h4>
Creating or changing routes should always occur in the context of the <code>wp_router_generate_routes</code> or <code>wp_router_alter_routes</code> actions, using the <code>WP_Router</code> object supplied to your callback function.
<ul>
<li><code>WP_Router::edit_route( string $id, array $changes )</code> – update each 
property given in <code>$changes</code> for the route with the given ID. Any properties 
not given in <code>$changes</code> will be left unaltered.</li>
<li><code>WP_Router::remove_route( string $id )</code> – delete the route with the given ID</li>
<li><code>WP_Router::get_route( string $id )</code> – get the <code>WP_Route</code> object for the given ID</li>
<li><code>WP_Router::get_url( string $id, array $arguments )</code> – get the URL to reach the route with the given ID, with the given query variables and their values</li>
<li><code>WP_Route::get( string $property )</code> – get the value of the specified property for 
the <code>WP_Route</code> instance</li>
</ul>

Alternatives to WP Router

Top alternatives