wp-connect

0.2.3 • Public • Published

wp-connect

Wordpress connect module

Layer to get resources from WordPress using the developer.wordpress.com/docs/api/.

API

WPCONN();

Create a new instance of WPCONN. If you wanna a way to get the access token then can use WPOAuth npm module.

var WPCONN = require('wp-connect');
var wpconn = WPCONN();

WPCONN#me();

var WPCONN = require('wp-connect');
var wpconn = new WPCONN('<your token>');
 
// get the user info
wpconn.me(function(err, user){
  // user info related with the given access token
});

WPCONN#site.id();

Set site identifier

WPCONN#site.info(params, fn);

Get the site information

var WPCONN = require('wp-connect');
var wpconn = new WPCONN('<your token here>');
 
// get site info
wpconn.site.id('blog.wordpress.com');
wpconn.site.info(function(err, site){
  // site data object
});

WPCONN#site.posts(params, fn);

Get the site posts

wpconn.site.id('blog.wordpress.com');
wpconn.site.posts({ number: 10 }, function(err, posts){
  // posts array
});

WPCONN.site.post.get(id, fn);

Get post site data

// get post data
wpconn.site.post.get(435, params, function(err, post){
  // post data object
});

WPCONN.site.post.getBySlug(slug, params, fn);

Get post site data by the given slug

// get post data
wpconn.site.post.getBySlug('we-are-the-loosers', function(err, post){
  // post data object
});

WPCONN.site.post.add(data, fn);

Add a new post

// post data
var data = {
  "title": "A new post",
  "slug": "a-new-post",
  "content": "<div>The content of the new post</div>"
};
 
wpconn.site.post.add(data, function(err, new_post){
  // object data of the new post already added
});

WPCONN.site.post.edit(id, data, fn);

Edit a post

wpconn.site.post.edit(321, { title: "new Title !!!" }, function(err, edit_post){
  // the title in edit_post has changed
});

Example

Into example/ folder download the npm dependencies:

$ npm install

... and then run the application

$ node index.js

Test

Create data.json file into test/ folder to can run the tests. You can copy or rename the test/data_example.json file.

{
  "client_id": "<your client_id here>",
  "client_secret": "<your client_secret here>",
  "token": "<your token app here>",
 
  "public_site": "<a public blog here>",
 
  "private_site": "<a private blog here>",
  "private_site_id": "<the ID of the private blog>",
 
  "new_post_data": {
    "title": "New testing post",
    "content": "<div style=\"color: red;\">The content of the new testing post</div>"
  }
}

... and then

$ make

License

MIT – Copyright 2014 Automattic

Readme

Keywords

none

Package Sidebar

Install

npm i wp-connect

Weekly Downloads

1

Version

0.2.3

License

none

Last publish

Collaborators

  • retrofox