moxie-leean/wp-endpoints-static

Generic but customisable endpoint to expose our static data via WP-API.

WP Endpoints: Static

Generic but customisable endpoint to expose our static data via WP-API. This extension will create an endpoint (at /wp-json/leean/v1/static by default)., _(*1)

The endpoint takes a no parameters and returns the following data:, _(*2)

• Site name
• Site tagline
• Menus
  • Menu location
    • Menu items
• Widgets

Getting Started

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

composer require moxie-leean/wp-endpoints-static

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

"require": {
  "moxie-leean/wp-endpoints-static": "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\StaticApi::init();

Usage

The extension has a number of filters which can be used to customised the output. In addition it does some useful extra manipulation of ACF data to make it more useful to a front-end app., _(*8)

Filters

Common parameters passed by many filers are:, _(*9)

• $endpoint : the name of the endpoint. Always '/static' for this extension.

ln_endpoints_api_namespace

Customise the API namespace ('leean' in /wp-json/leean/v1/static), _(*10)

add_filter( 'ln_endpoints_api_namespace', function( $namespace, $endpoint ) {
    return 'my-app';
}, 10, 2 );

ln_endpoints_api_version

Customise the API version ('v1' in /wp-json/leean/v1/static), _(*11)

add_filter( 'ln_endpoints_api_version', function( $version, $endpoint ) {
    return 'v2';
}, 10, 2 );

ln_endpoints_data

Customise the results just before they are sent., _(*12)

add_filter( 'ln_endpoints_data', function( $data, $endpoint ) {
    $data['site_title] = 'New Title;
    return $data;
}, 10, 3 );