A simple javascript library for the WP-REST-API and ACF to REST API
For install in your project do
npm install --save wp-simple-api-reader
- WP REST API v2.0 (wp version < 4.7)
- ACF to REST API plugins
- JWT Authentication for the WP REST API
import {WPReader, ACFReader} from 'wp-simple-api-reader';
const wpapi = new WPReader({'endpoint': 'http://localhost/headlessWP/'});
(async () => {
let result = await wpapi.posts({
'id': 1,
'per_page': 20,
'offset': 5,
'orderby': 'title'
});
result.data.forEach((post, index) => {
document.querySelector(`h1.post-${index}`).text = post.title;
});
})();
const wpacf = new ACFReader({
'endpoint': 'http://localhost/headlessWP/',
'auth': true,
'debug': true
});
(async () => {
wpacf.doAuth('username', 'password');
let result = await wpacf.page({
'id': 2,
'fieldName': 'page_test'
});
let value = result.data.acf.page_test;
})();
This object implements the method for the major endpoint in the WP REST API
Option | Desc |
---|---|
endpoint | (String) the URL at the Wordpress installations. (not wp-json/…) |
auth | (Boolean) Extends the WP REST API using JSON Web Tokens Authentication as an authentication method. I use JWT Authentication for WP REST API |
debug | (Boolean) Print in console all URL request |
- posts: Implement the posts’s endpoint of the WP REST API. This method is invoce the param object, for the param see Post Endpoint.
Set the paramid
for request single post with id - categories: Implement the categories’s endpoint of the WP REST API. This method is invoce the param object, for the param see Category Endpoint.
Set the paramid
for request single category with id - tags: Implement the tags’s endpoint of the WP REST API. This method is invoce the param object, for the param see Tag Endpoint.
Set the paramid
for request single tag with id - pages: Implement the pages’s endpoint of the WP REST API. This method is invoce the param object, for the param see Page Endpoint.
Set the paramid
for request single page with id - taxonomies: Implement the taxonomies's endpoint of the WP REST API. This method is invoce the param object, for the param see Taxonomy Endpoint.
Set the paramid
for request single taxonomy with slug - media: Implement the media’s endpoint of the WP REST API. This method is invoce the param object, for the param see Media Endpoint.
- comments: Implement the comments’s endpoint of the WP REST API. This method is invoce the param object, for the param see Comment Endpoint.
Set the paramid
for request single comment with id - users: Implement the users’s endpoint of the WP REST API. This method is invoce the param object, for the param see User Endpoint.
Set the paramid
for request single user with id - postTypes: Implement the post_types’s endpoint of the WP REST API. This method is invoce the param object, for the param see Post Type Endpoint.
Set the paramid
for request single post types with slug - doAuth: If options
auth
is set totrue
this method make an authentication call that save a token in the localstorage. The params of the method areusername, password, callback
thecallback
is a function called after the token is storate. - addCustomMethod: Create a custom method for a custom endpoint in the Wordpress endpoint. The params are
funName
: set a name of the function;method
: set a partial endpoint URL;baseEndpoint
: set a endpoint. Default 'wp-json/wp/v2/'
This object implements the method for all major endpoint in ACF to REST API plugins. The request return all (or single) ACF for the requested page, post, user, taxonomy
Option | Desc |
---|---|
endpoint | (String) the URL at the Wordpress installations. (not wp-json/…) |
auth | (Boolean) Extends the WP REST API using JSON Web Tokens Authentication as an authentication method. I use JWT Authentication for WP REST API |
debug | (Boolean) Print in console all URL request |
- posts: Implement the posts’s endpoint of the WP REST API. This method is invoce the param object, for the param see Post Endpoint.
Set the paramid
for request single post with id.
Set the paramfieldName
for request single ACF field with name. - categories: Implement the categories’s endpoint of the WP REST API. This method is invoce the param object, for the param see Category Endpoint.
Set the paramid
for request single category with id.
Set the paramfieldName
for request single ACF field with name. - pages: Implement the pages’s endpoint of the WP REST API. This method is invoce the param object, for the param see Page Endpoint.
Set the paramid
for request single page with id.
Set the paramfieldName
for request single ACF field with name. - media: Implement the media’s endpoint of the WP REST API. This method is invoce the param object, for the param see Media Endpoint.
Set the paramid
for request single media with id.
Set the paramfieldName
for request single ACF field with name. - comments: Implement the comments’s endpoint of the WP REST API. This method is invoce the param object, for the param see Comment Endpoint.
Set the paramid
for request single comment with id.
Set the paramfieldName
for request single ACF field with name. - users: Implement the users’s endpoint of the WP REST API. This method is invoce the param object, for the param see User Endpoint.
Set the paramid
for request single user with id Set the paramfieldName
for request single ACF field with name. - options: Implement the options’s endpoint of the WP REST API. This method is invoce the param object.
Set the paramid
for request single post option with id.
Set the paramfieldName
for request single ACF field with name. - doAuth: If options
auth
is set totrue
this method make an authentication call that save a token in the localstorage. The params of the method areusername, password, callback
thecallback
is a function called after the token is storate. - addCustomMethod: Create a custom method for a custom endpoint in the Wordpress endpoint. The params are
funName
: set a name of the function;method
: set a partial endpoint URL;baseEndpoint
: set a endpoint. Default 'wp-json/wp/v2/'