Description
Notice: This is the deprecated Version 1 of the WP REST API. It’s no longer supported beyond security fixes. Please consider WP REST API v2 for your website, although there are considerations to be aware of. If you activate both v1 and v2 on your website, then v1 will take priority and v2 will be inaccessible.
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/posts.
Update user with ID 4? Send a POST request to /wp-json/users/4. Get all
posts with the search term “awesome”? GET /wp-json/posts?filter[s]=awesome.
It’s that easy.
WP 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, WP API will let you do it.
WP 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 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!
All tickets for the project are being tracked on GitHub. You can also take a
look at the recent updates for the project.
Installation
Drop this directory in and activate it. You need to be using pretty permalinks
to use the plugin, as it uses custom rewrite rules to power the API.
Reviews
Good Plugin
Very Nice Plugin!!
need to explain how we use this with POSTMAN
plz explain how we shell assign a taxonomy to a post using POSTMAN
WORDPRESS FTP CREDENTIALS
This helped me fix the wordpress ftp credentials
Very Good Plugin
‘Very impressive work, This plugin is very helpful.’
4
When i installing this plugin,then it does not install.It’s give an error like..
Fatal error: Cannot redeclare json_api_init() (previously declared in /Applications/XAMPP/xamppfiles/htdocs/myproject/wp-content/plugins/json-api/json-api.php:24) in /Applications/XAMPP/xamppfiles/htdocs/myproject/wp-content/plugins/json-rest-api 2/plugin.php on line 50
Awesome Updates!!
Great Plugin and very good new releases
Contributors & Developers
“WP REST API (WP API)” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “WP REST API (WP API)” into your language.
Interested in development?
Browse the code or subscribe to the development log by RSS.
Changelog
1.2.5
-
Ensure media of private posts are private too.
Reported by @danielbachhuber on 2016-01-08.
1.2.4
-
Compatibilty with WordPress 4.4
Because WordPress 4.4 also registers rewrite rules for /wp-json/, WP-API v1 needs to register its rewrite rules with higher priority to continue to function as expected.
(props @danielbachhuber)
1.2.3
-
Fix potential XSS vulnerability.
Requests from other origins could potentially run code on the API domain, allowing cross-origin access to authentication cookies or similar.
Reported by @xknown on 2015-07-23.
1.2.2
-
Fix user access security vulnerability.
Authenticated users were able to escalate their privileges bypassing the
expected capabilities check.Reported by @kacperszurek on 2015-05-16.
1.2.1
-
Fix information disclosure security vulnerability.
Unauthenticated users could access revisions of published and unpublished posts. Revisions are now only accessible to authenticated users with permission to edit the revision’s post.
Reported by @chredd on 2015-04-09.
1.2
-
Add handling for Cross-Origin Resource Sharing (CORS) OPTIONS requests.
Preflighted requests (using the OPTIONS method) include the headers
Access-Control-Allow-Origin,Access-Control-Allow-Methods, and
Access-Control-Allow-Credentials in the response, if the HTTP origin is
set.(props @rmccue, #281)
-
Allow overriding full requests.
The
json_pre_dispatchfilter allows a request to be hijacked before it is
dispatched. Hijacked requests can be anything a normal endpoint can return.(props @rmccue, #281)
-
Check for JSON encoding/decoding errors.
Returns the last error (if any) occurred during the last JSON encoding or
decoding operation.(props @joshkadis, @rmccue, #461)
-
Add filtering to the terms collection endpoint.
Available filter arguments are based on the
get_terms()function. Example:
/taxonomies/category/terms?filter[number]=10 would limit the response to 10
category terms. -
Add handling for the
roleparameter when creating or updating a user.Allow users to be created or updated with a provided
role. -
Add handling for the
post_idparameter when creating media.Allow passing the
post_idparameter to associate a new media item with
a post.(props @pkevan, #294)
-
Handle route matching for
-in taxonomy and terms.Previously the regular expression used to match taxonomy and term names did
not support names with dashes.(props @EdHurtig, @evansobkowicz, #410)
-
Handle JSONP callback matching for
.in the function name.Previously the regular expression used to match JSONP callback functions did
not support names with periods.(props @codonnell822, #455)
-
Fix the Content-Type header for JSONP requests.
Previously JSONP requests sent the incorrect
application/jsonContent-Type
header with the response. This would result in an error if strict MIME
checking was enabled. The Content-Type header was corrected to
application/javascript for JSONP responses.(props @simonlampen, #380)
-
Add
$contextparameter tojson_prepare_termfilter.Terms responses can now be modified based on the
contextparameter of the
request.(props @traversal, #316)
-
Move the JavaScript client library into the plugin.
Previously, the
wp-api.jsfile was a separate repository. The JavaScript
client has moved back into the plugin to coordinate code changes.(props @tlovett1, #730)
-
Always return an object for media sizes
The media sizes value should always be an object even when empty. Previously,
if a media item did not have any sizes set, an empty array was returned.Compatibility warning: Clients should be prepared to accept an empty
object as a value for media sizes.(props @maxcutler, #300)
-
Give top-level posts a
nullparent value.For date type consistency, post parent property should be
null. Previously,
parent-less posts returned0for parent.Compatibility warning: Clients should be prepared to accept
nullas a
value for post parent.(props @maxcutler, #391)
-
Move permission checks out of
WP_JSON_Posts.Introduce
json_check_post_permission()function to allow post object
capability checks to be used outside theWP_JSON_Postsclass.Deprecation warning: Calling
WP_JSON_Posts::check_read_permissionand
WP_JSON_Posts::check_edit_permission is now deprecated. -
Split comment endpoints into separate class.
All comment handling has moved to the
WP_JSON_Commentsclass.Deprecation warning: Calling
WP_JSON_Posts::get_comments,
WP_JSON_Posts::get_comment,WP_JSON_Posts::delete_comment, and
WP_JSON_Posts::prepare_comment is now deprecated.(props @whyisjake, @rmccue, @rachelbaker, #378)
-
Split meta endpoints into separate class.
All post meta handling has moved to the new
WP_JSON_Meta_Postsclass.Deprecation warning: Calling
WP_JSON_Posts::get_all_meta,
WP_JSON_Posts::get_meta,WP_JSON_Posts::update_meta,
WP_JSON_Posts::add_meta,WP_JSON_Posts::delete_meta,
WP_JSON_Posts::prepare_meta, andWP_JSON_Posts::is_valid_meta_datais
now deprecated. -
Rename internal create methods.
Deprecation warning: Calling
WP_JSON_Posts::new_post,
WP_JSON_CustomPostType::new_post andWP_JSON_Posts::new_post
is now deprecated. -
Fix discrepancies in edit and create posts documentation examples.
Corrected the edit and create posts code examples in the Getting Started
section. The new post example was updated to include the required
content_raw parameter. The new and edit posts examples were updated to use
a correct date parameter.(props @rachelbaker, #305)
-
Update the cookie authentication documentation examples.
With 1.1 the localized JavaScript object for
wp-api.jschanged to
WP_API_Settings. This updates the Authentication section documentation
nonce example to use the updated object name.(props @rachelbaker, #321)
-
Add flexibility and multisite support to unit tests.
Tests can be run from any WordPress install, and are not limited to only as
a plugin installed within a WordPress.org develop checkout. Unit tests are
now run against a multisite installation.(props @danielbachhuber, #397)
-
Add
taxonomyslug to the term response.(props @kalenjohnson, #481)
-
Fix error when getting child comment.
Previously an error occurred when a requested comment had a parent.
-
Parse query strings before returning a JSON decode error.
(props @jtsternberg, #499)
-
Typecast the user ID parameter to be an integer for the
/users/{ID}route.(props @dimadin, #333)
-
Confirm a given JSONP callback is a string.
(props @ircrash, @rmccue, #405)
-
Register the JavaScript client in the admin.
(props @tlovett1, #473)
-
Remove duplicate error checks on post ids.
(props @danielbachhuber, #271)
-
Update documentation link references to wp-api.org.
(props @pollyplummer, #320)
-
Update documentation to note routes needing authentication.
-
Correct Post route documentation filter parameters.
-
Update taxonomy route documentation with correct paths.
-
Remove references to legacy
$fieldsparameter.(props @JDGrimes, #326)
-
Alter readme installation steps to use wp-cli for plugin and permalink setup.
(props @kadamwhite, #390)
-
Add steps to readme for executing tests with
vagrant ssh -c.(props @kadamwhite, #416)
-
Update readme to include provision step for testing suite.
(props @ironpaperweight, #396)
-
Update readme Getting Started link.
(props @NikV, #519)
-
Update readme Chassis repository links.
(props @Japh, #505)
-
Clean-up of
docsfolder.(props @pollyplummer, #441)
-
Documentation audit for plugin.php file.
(props @DrewAPicture, #293)
-
Rename tests to match class file naming.
(props @danielbachhuber, @rmccue, #359)
-
Add license.txt file with license terms.
-
Fix test_root when using WordPress.org developer checkout.
(props @markoheijnen, #437)
1.1
-
Add new routes for taxonomies and terms.
Taxonomies and terms have now been moved from the
/posts/types/<type>
namespace to global routes:/taxonomies,/taxonomies/<tax>,
/taxonomies//terms and/taxonomies/<tax>/terms/<term>Test coverage for taxonomy endpoints has also been increased to 100%.
Deprecation warning: The
/posts/types/<type>/taxonomiesendpoint (and
sub-endpoints with the same prefix) have been deprecated in favour of the new
endpoints. These deprecated endpoints will now return a
X-WP-DeprecatedFunction header indicating that the endpoint should not be
used for new development, but will continue to work in the future. -
Allow customizing the API resources prefix
The API base (typically
wp-json/) can now be customized to a different
prefix using thejson_url_prefixfilter. Note that rewrites will need to be
flushed manually after changing this. -
Give
nullas date for draft posts.Draft posts would previously return “0000-00-00 00:00:00” or
“1970-01-01T00:00:00”, as draft posts are not assigned a publish date. The API
now returnsnullwhere a date is not available.Compatibility warning: Clients should be prepared to accept
nullas a
value for date/time fields, and treat it as if no value is set. -
Fix errors with excerpt.
Posts without excerpts could previously return nonsense strings, excerpts from
other posts, or cause internal PHP errors. Posts without excerpts will now
always return an excerpt, typically automatically generated from the post
content.The
excerpt_rawfield was added to the edit context on posts. This field
contains the raw excerpt data saved for the post, including empty
string values. -
Only expose email for edit context.
User email addresses are now only exposed for
context=edit, which requires
theedit_userspermission (not required for the current user).The email address field will now return
falseinstead of a string if the
field is not exposed. -
Correct password-protected post handling.
Password-protected posts could previously be exposed to all users, however
could also have broken behaviour with excerpts. Password-protected posts are
now hidden to unauthenticated users, while content and excerpts are shown
correctly for theeditcontext.(Note that hiding password-protected posts is intended to be a temporary
measure, and will likely change in the future.) -
Add documentation on authentication methods.
Full documentation on authentication
is now available. This documentation explains the difference between the
various available authentication methods, and notes which should be used.(props @rmccue, #242)
-
Include new client JS from github.io
The WP-API Javascript library is now loaded dynamically from
wp-api.github.io to ensure it is always up-to-date. -
Don’t allow setting the modification date on post creation/update.
As it turns out, WP core doesn’t allow us to set this, so this was previously
a no-op anyway. Discovered during test coverage phase. -
Check post parent correctly on insertion.
Posts could previously be added with an invalid parent ID. These IDs are now
checked to ensure the post exists. -
Make sure the type is actually evaluated for
json_prepare_${type}filter.This value was previously not interpolated correctly, due to the use of the
single-quoted string type.(props @danielbachhuber, #266)
-
Return
WP_Errorinstead of array of empty objects for a revisions
permissions error.Previously, when trying to access post revisions without correct permissions,
a JSON list of internal error objects would be returned. This has been
corrected to return a standard API error instead. -
Flip user parameters check for insert/update.
Previously, you could add a user without specifying username/password/email,
but couldn’t update a user without those parameters. The logic has been
inverted here instead. -
Add revision endpoints tests
(props @danielbachhuber, @rachelbaker, @rmccue, #275, #277, #284, #279)
-
Add post endpoint testing
Now at >54% coverage for the whole class, and >80% for the main methods. This
figure will continue to rise over the next few releases.(props @rachelbaker, @rmccue, #99)
-
Separate helper functions into global namespace.
WP_JSON_Server::get_timezone(),
WP_JSON_Server::get_date_with_gmt(),
WP_JSON_Server::get_avatar_url() and “WP_JSON_Server::parse_date()` have
all been moved into the global namespace to decouple them from the server
class.Deprecation warning: These methods have been deprecated. The new
json_get_timezone(),json_get_date_with_gmt(),json_get_avatar_url()and
json_parse_date() methods should now be used instead. -
Re-order Users and Media routes documentation based on CRUD order
(props @rachelbaker, #214)
-
Update Post route documentation to provide more detail for data parameter
(props @rachelbaker, #212)
-
Correct documentation typo (“inforcement” -> “enforcement”).
(props @ericandrewlewis, #236)
-
Coding Standards audit
(props @DrewAPicture, #235)
-
Add comparison documentation.
-
json_urlfilter call should be passed$scheme(props @ericandrewlewis, #243)
-
Set
class-jsonserializable.phpfile mode to 644.(props @jeremyfelt, #255)
-
Remove unneeded “which” in implementation doc.
(props @JDGrimes, #254)
-
Fix a copy/paste error in schema doc.
(props @JDGrimes, #253)
-
Correct reference link in example schema.
(props @danielbachhuber, #258)
-
Add missing post formats to post schema documentation.
(props @danielbachhuber, #260)
-
Ensure we always use “public” on public methods.
(props @danielbachhuber, #268)
-
Ensure we don’t cause a PHP error if a post does not have revisions.
(props @rmccue, #227)
-
Add note to where upload_files cap comes from
(props @pkevan, #282)
-
Add handling of
stickyproperty when creating or editing posts.(props @rachelbaker, #218)
-
Update post route endpoint docs to include details on
post_metahandling.(props @rachelbaker, #213)
-
Update main readme file to better describe the project.
(props @rmccue, #303)
-
Fix
--data-binarycURL option in documentation
1.0
-
Add user endpoints.
Creating, reading, updating and deleting users and their data is now possible
by using the/usersendpoints./users/mecan be used to determine the
current user, and returns a 401 status for non-logged in users.Note that the format of post authors has changed, as it is now an embedded
User entity. This should not break backwards compatibility.Custom post types gain this ability automatically.
-
Add post meta endpoints.
Creating, reading, updating and deleting post meta is now possible by using
the/posts/<id>/metaendpoints. Post meta is now correctly embedded into
Post entities.Meta can be updated via the Post entity (e.g.
PUTto/posts/<id>) or via
the entity itself at/posts/<id>/meta/<mid>. Meta deletion must be done via
aDELETErequest to the latter.Only non-protected and non-serialized meta can be accessed or manipulated via
the API. This is not predicted to change in the future; clients wishing to
access this data should consider alternative approaches.Custom post types do not currently gain this ability automatically.
(props @attitude, @alisspers, @rachelbaker, @rmccue, @tlovett1, @tobych,
@zedejose, #68, #168, #189, #207) -
Add endpoint for deleting a single comment.
Clients can now send a
DELETErequest to comment routes to delete
the comment.Custom post types supporting comments will gain this ability automatically.
-
Add endpoint for post revisions.
Post revisions are now available at
/posts/<id>/revisions, and are linked in
themeta.links.version-historykey of post entities.Custom post types supporting revisions will gain this ability automatically.
(props @tlovett1, #193)
-
Respond to requests without depending on pretty permalink settings.
For sites without pretty permalinks enabled, the API is now available from
?json_route=/. Clients should check for this via the autodiscovery methods
(Link header or RSD). -
Add register post type argument.
Post types can now indicate their availability via the API using the
show_in_json argument passed toregister_post_type. This value defaults to
thepublicly_queryableargument (which itself defaults to the
public argument).(props @iandunn, @rmccue, #145)
-
Remove basic authentication handler.
This breaks backwards compatibility for clients using Basic
authentication. Clients are encouraged to switch to using OAuth
authentication. The Basic Authentication plugin can be
installed for backwards compatibility and local development, however should
not be used in production. -
Require nonces for cookie-based authentication.
This breaks backwards compatibility and requires any clients using cookie
authentication to also send a nonce with the request. The built-in Javascript
API automatically handles this. -
Clean up deprecated methods/functions.
Functions and methods previously deprecated in 0.8/0.9 have now been removed.
Future deprecations will take place in the same manner as WordPress core.This breaks backwards compatibility, however these were marked as
deprecated in previous releases.(props @rmccue, #187)
-
Only expose meta on ‘edit’ context as a temporary workaround.
Privacy concerns around exposing meta to all users necessitate this change.
This breaks backwards compatibility as post meta data is no longer
available to all users. Clients wishing to access this data should
authenticate and use theeditcontext.(props @iandunn, @rmccue, #135)
-
Add
json_ensure_responsefunction to ensure either a
WP_JSON_ResponseInterface or aWP_Errorobject is returned.When extending the API, the
json_ensure_responsefunction can be used to
ensure that any raw data returned is wrapped with aWP_JSON_Responseobject.
This allows usingget_status/get_dataeasily, howeverWP_Errormust
still be checked viais_wp_error. -
Use version option to check on init if rewrite rules should be flushed.
Rewrite rules on multisite are now flushed via an init hook, rather than
switching to each site on activation.(props @rachelbaker, #149)
-
Fix typo in schema docs
(props @codebykat, #132)
-
Add check for valid JSON data before using to avoid parameter overwrite.
When passing data to an endpoint that accepts JSON data, the data will now be
validated before passing to the endpoint.(props @rachelbaker, @rmccue, #133)
-
Add authentication property to site index.
(props @rmccue, #131)
-
Move the test helper to a subdirectory.
The plugin will now no longer prompt for updates due to the helper.
(props @rmccue, #127)
-
Include post ID with
json_prepare_metafilter.(props @rmccue, #137)
-
Corrected parameter names in x-form examples in docs.
(props @rachelbaker, #134)
-
Pass
WP_JSON_Serverinstance tojson_serve_request. -
Don’t use deprecated function in
WP_JSON_Posts::edit_post()(props @rachelbaker, #150)
-
Pass post ID to
json_insert_postaction during both insert and update.(props @cmmarslender, #148)
-
Add descriptions to taxonomy term data.
(props @pushred, #111)
-
Ensure we handle raw data passed to the API.
-
Remove unused
prepare_authormethod fromWP_JSON_Postsclass.(props @rachelbaker, #165)
-
Add multiple post type support to get_posts method.
-
Return
WP_ErrorinWP_JSON_Posts::get_commentfor invalid comments. -
Update getting started documentation.
(props @rmccue, #176)
-
Improve and clarify “array” input syntax documentation.
-
Update post routes documentation.
-
Add documentation for user endpoints.
(props @rachelbaker, @rmccue, #158)
-
Add permalink settings step to Quick Setup instructions.
(props @kadamwhite, #183)
-
Update taxonomy collection to return indexed array.
(props @mattheu, #184)
-
Remove placeholder endpoints.
-
Fix issues with embedded attachments.
Checks that the post supports attachment data before adding it, and ensures we
don’t embed entities many layers deep.(props @rmccue, #194)
-
Change post parent preparation context to embed.
(props @rmccue, #195)
-
Change server meta links to reference the WP-API organization GitHub repo.
(props @rachelbaker, #208)
-
Fix plugin tests
(props @rmccue, #215)
-
Check for errors with invalid dates and remove duplicate date parsing
methods.
0.9
-
Move from
wp-json.php/towp-json/This breaks backwards compatibility and requires any clients to now use
wp-json/, or preferably the new RSD/Link headers. -
Move filter registration out of CPT constructor. CPT subclasses now require
you to call$myobject->register_filters(), in order to move global state out
of the constructor.This breaks backwards compatibility and requires any subclassing to now
call$myobject->register_filters() -
Introduce Response/ResponseInterface
Endpoints that need to set headers or response codes should now return a
WP_JSON_Response rather than using the server methods.
WP_JSON_ResponseInterface may also be used for more flexible use of the
response methods.Deprecation warning: Calling
WP_JSON_Server::header,
WP_JSON_Server::link_header andWP_JSON_Server::query_navigation_headers
is now deprecated. This will be removed in 1.0.(props @rmccue, #33)
-
Change all semiCamelCase names to underscore_case.
Deprecation warning: Any calls to semiCamelCase methods require any
subclassing to update method references. This will be removed in 1.0. -
Add multisite compatibility. If the plugin is network activated, the plugin is
now activated once-per-site, sowp-json/is always site-local. -
Add RSD and Link headers for discovery
(props @rmccue, #40)
-
WP_JSON_Posts->prepare_author() now verifies the
$userobject is set. -
Added unit testing framework. Currently only a smaller number of tests, but we
plan to increase this significantly as soon as possible. -
Link collection filtering docs to URL formatting guide.
(props @kadamwhite, #74)
-
Remove hardcoded
/pagesreferences fromWP_JSON_Pages -
Fix compatibility with
DateTime::createFromFormaton PHP 5.2 -
Document that
WP_JSON_CustomPostType::__construct()requires a param of type
WP_JSON_ResponseHandler.(props @tlovett1, #88)
-
Add timezone parameter to WP_JSON_DateTime::createFromFormat()
-
Remove IXR references.
IXR_Erroris no longer accepted as a return value.This breaks backwards compatibility and requires anyone returning
IXR_Error objects to now returnWP_ErrororWP_JSON_ResponseInterface
objects. -
Fix bugs with attaching featured images to posts:
WP_JSON_Media::attachThumbnail()should do nothing if$updateis false
without a post ID- The post ID must be fetched from the
$postarray.
(props @Webbgaraget, #55)
-
Don’t declare
jsonSerializeon ResponseInterface(props @rmccue, #97)
-
Allow JSON post creation/update for
WP_JSON_CustomPostType -
Return null if post doesn’t have an excerpt
(props @rachelbacker, #72)
-
Fix link to issue tracker in README
(props @rmccue, @tobych, #125)
0.8
-
Add compatibility layer for JsonSerializable. You can now return arbitrary
objects from endpoints and use thejsonSerialize()method to return the data
to serialize instead of just using the properties of the object.(props @rmccue, #24)
-
Fix page parent links to use
/pages(props @thenbrent, #27)
-
Remove redundant
WP_JSON_Pages::type_archive_link()function(props @thenbrent, #29)
-
Removed unneeded executable bit on all files
(props @tierra, #31)
-
Don’t include the
featured_imageproperty for post types that don’t
support thumbnails(props @phh, #43)
-
Use
wp_json_server_before_serveinstead ofplugins_loadedin the Extending
documentation for plugins(props @phh, #43)
-
Parse the avatar URL from the
get_avatar()function in core, allowing custom
avatar implementations -
Ensure that the author is set if passed
(props @kuchenundkakao, #44)
-
Clarify the usage of
WP_JSON_CustomPostTypein plugins(props @rmccue, #45)
-
Ensure JSON disabled error messages are translated
(props @rmccue, #38)
-
Remove extra “Link: ” from link headers
-
Remove redundant
get_avatarmethod inWP_JSON_Posts(props @rachelbaker, #35)
-
Rename
WP_JSON_Server::get_avatar()toWP_JSON_Server::get_avatar_url()(props @rachelbaker, #35)
0.7
-
The response handler object is now passed into the endpoint objects via the
constructor, allowing you to avoid excess global state where possible. It’s
recommended to use this where possible rather than the global object.(props @rmccue, #2)
-
Fix undefined variables and indices
(props @pippinsplugins, #5) -
Correct call to deactivation hook
(props @ericpedia, #9) -
Check metadata access correctly rather than always hiding for users without
theedit_post_metacapability
(props @kokarn, #10) -
Return all term metadata, rather than just the last one
(props @afurculita, #13) -
Access post metadata from cache where possible – Note, this is a backwards
compatibility break, as the format of the metadata has changed. This may
change again in the near future, so don’t rely on it until 1.0.
(props @afurculita, #14) -
Add term_link to prepare_term
(props @afurculita, #15) -
Fix hardcoded
/pagesreferences inWP_JSON_CustomPostType
(props @thenbrent, #26) -
Sanitize headers for newlines
(props @kokarn, #7) -
Register rewrite rules during plugin activation
(props @pippinsplugins, #17)
0.6
- Huge documentation update – Guides on getting started and extending the API
are now available for your perusal - Add generic CPT class – Plugins are now encouraged to extend
WP_JSON_CustomPostType and get free hooking for common actions. This
removes most of the boilerplate that you needed to write for new CPT-based
routes and endpoints (#380) - Use defined filter priorities for endpoint registration – It’s now easier to
inject your own endpoints at a defined point - Update the schema – Now includes documentation on the Media entity, plus more
(#264) - Add better taxonomy support – You can now query for taxonomies and terms
directly. The routes here might seem strange
(/posts/types/post/taxonomies/categoryfor example), but the intention is
to future-proof them
as much as possible(#275) - Ensure the JSON URL is relative to the home URL (#375)
- Check all date formats for If-Unmodified-Since (#378)
- Register the correct URL for the JS library (#376)
- Correct the usage of meta links (#379)
- Add filters for post type and post status data (#380)
- Separate parent post and parent comment relation (#330()
0.5
- Add support for media – This has been a long time coming, and it’s finally at
a point where I’m happy to push it out. Good luck. (#272) -
Separate the post-related endpoints – Post-related endpoints are now located
in theWP_JSON_Postsclass. When implementing custom post type support,
it’s recommended to subclass this.The various types are now also only registered via hooks, rather than
directly in the server class, which should make it easier to override them
as well (#348) - Add page support – This is a good base if you’re looking to create your own
custom post type support (#271) - Switch from fields to context – Rather than passing in a list of fields that
you want, you can now pass in a context (usuallyvieworedit)
(#328). - Always send headers via the server handler – Endpoints are now completely
separate from the request, so the server class can now be used for
non-HTTP/JSON handlers if needed (#293) - Use better error codes for disabled features (#338)
- Send
X-WP-TotalandX-WP-TotalPagesheaders for information on
post/pagination counts (#266)
0.4
- Add Backbone-based models and collections – These are available to your code
by declaring a dependency onwp-api(#270) - Check
json_routebefore using it (#336) - Conditionally load classes (#337)
- Add additional test helper plugin – Provides code coverage as needed to the
API client tests. Currently unused. (#269) - Move
json_url()andget_json_url()toplugin.php– This allows using
both outside of the API itself (#343) getPost(0)now returns an error rather than the latest post (#344)- View all changes
0.3
- Add initial comment endpoints to get comments for a post, and get a single
comment (#320) - Return a Post entity when updating a post, rather than wrapping it with
useless text (#329) - Allow filtering the output as well as input. You can now use the
json_dispatch_args filter for input as well as thejson_serve_request
filter for output to serve up alternative formats (e.g. MsgPack, XML (if
you’re insane)) - Include a
profilelink in the index, to indicate the JSON Schema that the
API conforms to. In the future, this will be versioned.
0.2
- Allow all public query vars to be passed to WP Query – Some private query vars
can also be passed in, and all can if the user hasedit_posts
permissions (#311) - Pagination can now be handled by using the
pageargument without messing
with WP Query syntax (#266) - The index now generates links for non-variable routes (#268)
- Editing a post now supports the
If-Unmodified-Sinceheader. Pass this in to
avoid conflicting edits (#294) - Post types and post statuses now have endpoints to access their data (#268)
- View all changes
0.1.2
- Disable media handling to avoid fatal error (#298)
0.1.1
- No changes, process error
0.1
- Enable the code to be used via the plugin architecture (now uses rewrite rules
if running in this mode) - Design documents are now functionally complete for the current codebase
(#264) - Add basic writing support (#265)
- Filter fields by default – Unfiltered results are available via their
corresponding*_rawkey, which is only available to users with
edit_posts (#290) - Use correct timezones for manual offsets (GMT+10, e.g.) (#279)
- Allow permanently deleting posts (#292)
- View all changes
0.0.4
- Hyperlinks now available in most constructs under the ‘meta’ key. At the
moment, the only thing under this key is ‘links’, but more will come
eventually. (Try browsing with a browser tool like JSONView; you should be
able to view all content just by clicking the links.) - Accessing / now gives an index which briefly describes the API and gives
links to more (also added the HIDDEN_ENDPOINT constant to hide from this). - Post collections now contain a summary of the post, with the full post
available via the single post call. (prepare_post() has fields split into
post and post-extended) - Post entities have dropped post_ prefixes, and custom_fields has changed to
post_meta. - Now supports JSONP callback via the _jsonp argument. This can be disabled
separately to the API itself, as it’s only needed for
cross-origin requests. - Internal: No longer extends the XMLRPC class. All relevant pieces have been
copied over. Further work still needs to be done on this, but it’s a start.
0.0.3
- Now accepts JSON bodies if an endpoint is marked with ACCEPT_JSON