Backbone library for the WordPress REST API or "WP-API"

Thislibrary provides an interface for the[WP REST API](https://github.com/WP-API/WP-API) by providing Backbone ModelsandCollections for all endpoints in the API.

Thisclient is now bundled in WordPress coreanddevelopment is happening there, seehttps://trac.wordpress.org.

Activate the WP-API plugin. Enqueue the script directly:

wp_enqueue_script( 'wp-api' );

or as a dependency for your script:

wp_enqueue_script( 'my_script', 'path/to/my/script', array( 'wp-api' ) );

The library parses the root endpoint (the 'Schema') and creates matching Backbone models and collections. You will now have two root objects available to you:`wp.api.models` and`wp.api.collections`.

The models and collections include:

You can use these endpoints as-is to read, update, create and delete items using standard Backbone methods (fetch, sync, save & destroy for models, sync for collections). You can also extend these objects to make them your own, and build your views on top of them.

Each model and collection includes a reference to its default values, for example:

Each model and collection contains a list of methods the corresponding endpoint supports. For example, models created from`wp.api.models.Post` have a methods array of:

Each model and collection contains a list of options the corrosponding endpoint accepts (note that options are passed as the second parameter when creating models or collections), for example:

The client will accept and use a localized schema as part of the`wpApiSettings` object. The Schema is currently not passed by default; instead the client makes an ajax request to the API to load the Schema, then caches it in the browser's session storage (if available). Activating the client-js plugin with`SCRIPT_DEBUG` enabled uses a localized Schema. Check the[client-js example](https://github.com/WP-API/client-js/blob/master/client-js.php) or this branch which[attempts to only localize the schema once per client](https://github.com/WP-API/client-js/compare/features/only-localize-schma-once?expand=1).

Client startup is asynchronous. If the api schema is localized, the client can start immediately; if not the client makes an ajax request to load the schema. The client exposes a load promise for provide a reliable wait to wait for client to be ready:

wp.api.loadPromise.done(function() {

} )

To create a post and edit its categories, make sure you are logged in, then:

var post=newwp.api.models.Post( { title:'This is a test post' } );

post.save();

var post=newwp.api.models.Post( { id:1 } );

post.fetch();

post.getCategories().done(function(postCategories ) {

console.log( postCategories[0].name );

} );

post.getAuthorUser().done(function(user ){

console.log(user.get('name' ) );

} );

post.getFeaturedImage().done(function(image ){

console.log( image );

} );

post.setCategories( ['apples','oranges' ] );

var allCategories=newwp.api.collections.Categories()

allCategories.fetch();

var appleCategory=allCategories.findWhere( { slug:'apples' } );

appleCategory.set('parent_post',post.get('id' ) );

postCategories.create(appleCategory.toJSON(), { type:'POST' } );

postCategories.at(0 ).destroy();

postCategories=post.getCategories();

postCategories.at(0 ).get('name' );

to get the last 10 posts:

var postsCollection=newwp.api.collections.Posts();

postsCollection.fetch();

to get the last 25 posts:

postsCollection.fetch( { data: { per_page:25 } } );

use filter to change the order & orderby options:

postsCollection.fetch( { data: {'filter': {'orderby':'title','order':'ASC' } } } );

All collections support pagination automatically, and you can get the next page of results using`more`:

postsCollection.more();

to get page 5 of a collection:

posts.fetch( { data: { page:5 } } );

check if the collection has any more posts:

posts.hasMore();

You can access post or page revisions using the PostRevisions or PageRevisions collections or through the Post or Page collection.

For example, to get a collection of all revisions of post ID 1:

Revision collections can also be accessed via their parent's collection. This example makes 2 HTTP requests instead of one, but now the original post and its revisions are avaible:

If you add custom endpoints to the api they will also become available as models/collections. For example, you will get new models and collections when you[add REST API support to your custom post type](http://v2.wp-api.org/extending/custom-content-types/). Note: because the schema is stored in the user's session cache to avoid re-fetching, you may need to open a new tab to get a new read of the Schema.

To develop, build and test this library, you must have[Node](http://nodejs.org) installed. For Windows users, simply[download](http://nodejs.org/download/) and install Node. For Mac users, we recommend installing Node using[Homebrew](http://mxcl.github.com/homebrew/). Once Homebrew is installed, run`brew install node` to install Node.js.

Clone this repository, and then execute the following commands within the checkout directory:

$ npm install

This will use Node's NPM package manager to install all the dependencies for building and testing this library. We use[Bower](http://bower.io) to manage client script dependencies, but Bower script installation is handled as part of the`npm install` command.

To update the compiled JavaScript files in the`build/` directory after you've made changes, run the library's`build` script with the npm command:

$ npm run build

This will use[Grunt](http://gruntjs.com) to check the source scripts in`js/` for syntax errors, then concatenate and minify them to create[the minified wp-api.min.js file](build/js/wp-api.min.js) and a corresponding source map file.

You can run the unit tests for this library using Grunt:

$ npmtest

The custom "build" and "test" scripts defined in this library's[package.json](package.json) enable access to Grunt's functionality after a simple`npm install`; however, these commands can also be run directly using Grunt itself. In order to gain access to the`grunt` console command, you must globally install the Grunt command-line interface:

$ npm install -g grunt-cli

Once`grunt-cli` has been installed, you can run the build and test commands with`grunt` and`grunt test`, respectively, without having to invoke the scripts via NPM.

Documentation has moved to the WordPress handbook:https://developer.wordpress.org/rest-api/using-the-rest-api/backbone-javascript-client/