moxie-lean/wp-endpoints-routes

Get the set of routes.

2.0.2 2016-06-03 16:28 UTC

Requires

• php: >=5.4
• moxie-lean/wp-endpoint: 2.*.*

Requires (Dev)

• squizlabs/php_codesniffer: 2.*
• wp-coding-standards/wpcs: 0.9.0

MIT

• Adam Fenton
• Crisoforo Gaspar Hernandez

• api
• wordpress

README

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).

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).

Getting Started

The easiest way to install this package is by using composer from your terminal:

composer require moxie-lean/wp-endpoints-routes

Or by adding the following lines on your composer.json file

"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.

After that you can include the autoload.php file in order to be able to autoload the class during the object creation.

include '/vendor/autoload.php';

Finally you need to initialise the endpoint by adding this to your code:

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

Usage

The endpoint takes no inputs and returns data in the following format:

[
  {
    "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:

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 );
}