Official JavaScript library for the WordPress.com REST API. Compatible with Node.js and web browsers.
Introduce the wpcom
dependency into your package.json
, and then initialize
it with your API token (optional).
// Edit a post on a site
var wpcom = require('wpcom')('<your-token>');
var blog = wpcom.site('your-blog.wordpress.com');
blog.posts({ number: 8 }, function(err, list) { ... });
Include dist/wpcom.js
in a <script>
tag:
<script src="wpcom.js"></script>
<script>
var wpcom = WPCOM('<your-token>');
var blog = wpcom.site('your-blog.wordpress.com');
blog.posts({ number: 8 }, function(err, list) { ... });
</script>
Not all requests require a REST API token. For example, listing posts on a public site is something anyone can do.
If you do need a token, here are some links that will help you generate one:
- OAuth2 Authentication at WordPress.com Developer Resources
wpcom-oauth-cors
: a client-side WordPress.com OAuth2 library using CORSwpcom-oauth
: a server-side (Node.js) WordPress.com OAuth2 library- If you just want to quickly create a token, the
example app bundled with
wpcom-oauth
is probably the easiest way.
// Edit a post on a site
var wpcom = require('wpcom')('<your-token>');
var blog = wpcom.site('your-blog.wordpress.com');
blog.post({ slug: 'a-post-slug' }).update(data, function(err, res) { ... });
You can omit the API token for operations that don't require permissions:
// List the last 8 posts on a site
var wpcom = require('wpcom')();
var blog = wpcom.site('your-blog.wordpress.com');
blog.posts({ number: 8 }, function(err, list) { ... });
More pre-made examples are in the examples/
directory.
The token
and site
vars must be given to testing scripts either using
TOKEN
and SITE
environment vars respectively or through of a
config.json file into test/
folder like bellow:
{
"site": "<site-url>",
"token": "<token>"
}
Run tests:
$ make test-all
Also tests can be filtered using make test <filter>
:
$ make test wpcom.site.post
MIT โ Copyright 2014 Automattic