PHPackages                             wp-api/wp-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. wp-api/wp-api

AbandonedArchivedWordpress-plugin[API Development](/categories/api)

wp-api/wp-api
=============

Access your WordPress site's data through an easy-to-use HTTP REST API.

2.0-beta15(9y ago)3.9k131.4k646[49 issues](https://github.com/WP-API/WP-API/issues)[3 PRs](https://github.com/WP-API/WP-API/pulls)GPL2+PHP

Since May 28Pushed 8y ago220 watchersCompare

[ Source](https://github.com/WP-API/WP-API)[ Packagist](https://packagist.org/packages/wp-api/wp-api)[ Docs](http://wp-api.org/)[ RSS](/packages/wp-api-wp-api/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelog (10)Dependencies (3)Versions (54)Used By (0)

WP REST API v2.0 (formerly known as WP-API)
===========================================

[](#wp-rest-api-v20-formerly-known-as-wp-api)

Access your WordPress site's data through an easy-to-use HTTP REST API.

**Development is no longer taking place in this repository**.

- For support requests, use the [WordPress forums](https://wordpress.org/support/).
- For bugs and patches, use [WordPress core Trac](https://core.trac.wordpress.org). Be sure to include full details and reproduction steps about the issue you are experiencing, and ideally a patch with unit tests.

The **"develop"** branch is version 2 which represents the last "beta" versions of the [plugin](https://wordpress.org/plugins/rest-api/). [Read the documentation](https://developer.wordpress.org/rest-api/)to introduce yourself to endpoints, internal patterns, and implementation details.

The **"master"** branch represents the **legacy** version of the REST API.

About
-----

[](#about)

WordPress is moving towards becoming a fully-fledged application framework, and we need new APIs. This project was born to create an easy-to-use, easy-to-understand and well-tested framework for creating these APIs, plus creating APIs for core.

This plugin provides an easy to use REST API, available via HTTP. Grab your site's data in simple JSON format, including users, posts, taxonomies and more. Retrieving or updating data is as simple as sending a HTTP request.

Want to get your site's posts? Simply send a `GET` request to `/wp-json/wp/v2/posts`. Update user with ID 4? Send a `PUT` request to `/wp-json/wp/v2/users/4`. Get the page with slug "about-me"? `GET /wp-json/wp/v2/pages?slug=about-me`. Get all posts with the search term "awesome"? `GET /wp-json/wp/v2/posts?search=awesome`. It's that easy.

The WordPress REST API exposes a simple yet easy interface to WP Query, the posts API, post meta API, users API, revisions API and many more. Chances are, if you can do it with WordPress, the API will let you do it.

The REST API also includes an easy-to-use JavaScript API based on Backbone models, allowing plugin and theme developers to get up and running without needing to know anything about the details of getting connected.

Check out [our documentation](https://developer.wordpress.org/rest-api/) for information on what's available in the API and how to use it. We've also got documentation on extending the API with extra data for plugin and theme developers!

The API code in this plugin is currently integrated into core WordPress starting in [4.7](https://wordpress.org/news/2016/12/vaughan/).

**Development is no longer taking place in this repository**.

- For support requests, use the [WordPress forums](https://wordpress.org/support/).
- For bugs and patches, use [WordPress core Trac](https://core.trac.wordpress.org). Be sure to include full details and reproduction steps about the issue you are experiencing, and ideally a patch with unit tests.

Quick Setup
-----------

[](#quick-setup)

Want to test out the WP REST API? The easiest way is just to install a recent version of WordPress ([4.7](https://wordpress.org/news/2016/12/vaughan/) or later).

### Testing

[](#testing)

You can also set up a development environment to work on the API code.

See the [instructions for running the WordPress PHPUnit test suite](https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/)to get started.

Issue Tracking
--------------

[](#issue-tracking)

All tickets for the project are being tracked on [WordPress core Trac](https://core.trac.wordpress.org).

Some previous issues can be found on the [issue tracker for this repository](/WP-API/WP-API/issues); however, now that development of the API has moved to core Trac, new issues **should not be filed here**.

Contributing
------------

[](#contributing)

Want to get involved? Check out [Contributing.md](CONTRIBUTING.md) for details on submitting fixes and new features.

Security
--------

[](#security)

We take the security of the API extremely seriously. If you think you've found a security issue with the API (whether information disclosure, privilege escalation, or another issue), we'd appreciate responsible disclosure as soon as possible.

To report a security issue, you can either email `security[at]wordpress.org`, or [file an issue on HackerOne](https://hackerone.com/wp-api). We will attempt to give an initial response to security issues within 48 hours at most, however keep in mind that the team is distributed across various timezones, and delays may occur as we discuss internally.

(Please note: For testing, you should install a copy of the project and WordPress on your own server. **Do not test on servers you do not own.**)

License
-------

[](#license)

[GPLv2+](http://www.gnu.org/licenses/gpl-2.0.html)

###  Health Score

47

—

FairBetter than 94% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity59

Moderate usage in the ecosystem

Community39

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~21 days

Recently: every ~48 days

Total

24

Last Release

3510d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/21655?v=4)[Ryan McCue](/maintainers/rmccue)[@rmccue](https://github.com/rmccue)

---

Top Contributors

[![danielbachhuber](https://avatars.githubusercontent.com/u/36432?v=4)](https://github.com/danielbachhuber "danielbachhuber (1135 commits)")[![rachelbaker](https://avatars.githubusercontent.com/u/979807?v=4)](https://github.com/rachelbaker "rachelbaker (991 commits)")[![rmccue](https://avatars.githubusercontent.com/u/21655?v=4)](https://github.com/rmccue "rmccue (944 commits)")[![joehoyle](https://avatars.githubusercontent.com/u/161683?v=4)](https://github.com/joehoyle "joehoyle (429 commits)")[![BE-Webdesign](https://avatars.githubusercontent.com/u/16389612?v=4)](https://github.com/BE-Webdesign "BE-Webdesign (93 commits)")[![adamsilverstein](https://avatars.githubusercontent.com/u/2676022?v=4)](https://github.com/adamsilverstein "adamsilverstein (78 commits)")[![kadamwhite](https://avatars.githubusercontent.com/u/442115?v=4)](https://github.com/kadamwhite "kadamwhite (53 commits)")[![schlessera](https://avatars.githubusercontent.com/u/83631?v=4)](https://github.com/schlessera "schlessera (32 commits)")[![websupporter](https://avatars.githubusercontent.com/u/6458412?v=4)](https://github.com/websupporter "websupporter (29 commits)")[![ntwb](https://avatars.githubusercontent.com/u/1016458?v=4)](https://github.com/ntwb "ntwb (24 commits)")[![tlovett1](https://avatars.githubusercontent.com/u/1844351?v=4)](https://github.com/tlovett1 "tlovett1 (23 commits)")[![westonruter](https://avatars.githubusercontent.com/u/134745?v=4)](https://github.com/westonruter "westonruter (17 commits)")[![Shelob9](https://avatars.githubusercontent.com/u/1994311?v=4)](https://github.com/Shelob9 "Shelob9 (16 commits)")[![nylen](https://avatars.githubusercontent.com/u/227022?v=4)](https://github.com/nylen "nylen (15 commits)")[![Soean](https://avatars.githubusercontent.com/u/695201?v=4)](https://github.com/Soean "Soean (14 commits)")[![pento](https://avatars.githubusercontent.com/u/352291?v=4)](https://github.com/pento "pento (14 commits)")[![NikV](https://avatars.githubusercontent.com/u/5368857?v=4)](https://github.com/NikV "NikV (13 commits)")[![patrickgalbraith](https://avatars.githubusercontent.com/u/811945?v=4)](https://github.com/patrickgalbraith "patrickgalbraith (11 commits)")[![danielpunkass](https://avatars.githubusercontent.com/u/14606?v=4)](https://github.com/danielpunkass "danielpunkass (11 commits)")[![afurculita](https://avatars.githubusercontent.com/u/3129631?v=4)](https://github.com/afurculita "afurculita (10 commits)")

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/wp-api-wp-api/health.svg)

```
[![Health](https://phpackages.com/badges/wp-api-wp-api/health.svg)](https://phpackages.com/packages/wp-api-wp-api)
```

###  Alternatives

[sybrew/the-seo-framework

An automated, advanced, accessible, unbranded and extremely fast SEO solution for any WordPress website.

47078.8k](/packages/sybrew-the-seo-framework)[a2design-company/mandrill-cakephp-plugin

Mandrill CakePHP plugin

193.2k](/packages/a2design-company-mandrill-cakephp-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
