moxie-leean/wp-endpoints-routes

Get the set of routes.

WP Endpoints: Routes

Get the set of routes and exposes them via WP-API. This extension will create an endpoint (at /wp-json/lean/v1/routes by default)., _(*1)

Current State

As of now the endpoint only adds pages automatically. You can manually add others using the ln_endpoints_data_routes filter (see below)., _(*2)

Getting Started

The easiest way to install this package is by using composer from your terminal:, _(*3)

composer require moxie-lean/wp-endpoints-routes

Or by adding the following lines on your composer.json file, _(*4)

"require": {
  "moxie-lean/wp-endpoints-routes": "dev-master"
}

This will download the files from the packagist site and set you up with the latest version located on master branch of the repository., _(*5)

After that you can include the autoload.php file in order to be able to autoload the class during the object creation., _(*6)

include '/vendor/autoload.php';

Finally you need to initialise the endpoint by adding this to your code:, _(*7)

\Leean\Endpoints\Routes::init();

Usage

The endpoint takes no inputs and returns data in the following format:, _(*8)

[
  {
    "state": "home",
    "url": "/",
    "template": "home",
    "endpoint": "post",
    "params": {
      "id": 123
    }
  },
  {
    "state": "allPhotos",
    "url": "/photos",
    "template": "allPhotos",
    "endpoint": "collection",
    "params": {
      "type": "photo",
      "posts_per_page": 10
    }
  },
  {
    "state": "authorPhotos",
    "url": "/photos/:authorId",
    "template": "authorPhotos",
    "endpoint": "collection",
    "params": {
      "type": "photo",
      "posts_per_page": 10
    }
  },
  {
    "state": "photo",
    "url": "/photos/:authorId/:photoId",
    "template": "photo",
    "endpoint": "post",
    "params": {}
  }
]

Adding Extra Routes

You can do this with the ln_endpoints_data_routes filter as follows:, _(*9)

add_filter( 'ln_endpoints_data_routes', 'add_extra_routes' );

function add_extra_routes( $routes ) {
    $extra_routes = [
        [
            'state' => 'blog',
            'url' => '/blog/',
            'template' => 'blog',
            'endpoint' => 'collection',
            'params' => [
                'type' => 'post',
                'posts_per_page' => 5,
            ]
        ],
    ];

    return array_merge( $routes, $extra_routes );
}