An example RESTful API for WordPress built with ZF2 and Apigility.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.puppet
config
data/cache
module
public
.gitignore
CONTRIBUTING.md
LICENSE.txt
README.md
Vagrantfile
composer.json
restful-wp.php

README.md

#RESTful WP

##Description##

This is an example REST API for WordPress built with Zend Framework 2 and Apigility. It's only listed here for reference (or for kicks) and is not intended for production use or as a replacement for the upcoming WP-API which is due to be merged into WordPress core.

Since it uses ZF2/Apigility, it's very extensible and has a lot of features built in or ready to be dropped in, including OAuth support, JSON/HAL responses, etc.

Routes are self-explanatory once viewing the Apigility dashboard if in development mode, or by viewing the /module/WordPress/src/WordPressV1/Rest/ directory.

Requirements

Please see the composer.json file.

Installation

Download

  • Download this repo and place it on your webserver.
  • Define the WP_LOAD_FILE constant in the WordPress/module.php file with the absolute path to the 'wp-load.php' file for the WordPress site you want to manage via API.

Instructions for setting up on a development environment mirror that of Apigility, so those instructions are included below.

All methods

Once you have the basic installation, you need to put it in development mode:

cd path/to/install
php public/index.php development enable # put the skeleton in development mode

Now, fire it up! Do one of the following:

  • Create a vhost in your web server that points the DocumentRoot to the public/ directory of the project
  • Fire up the built-in web server in PHP (5.4.8+) (note: do not use this for production!)

In the latter case, do the following:

cd path/to/install
php -S 0.0.0.0:8080 -t public public/index.php

You can then visit the site at http://localhost:8080/ - which will bring up a welcome page and the ability to visit the dashboard in order to create and inspect the APIs.

NOTE ABOUT USING THE PHP BUILT-IN WEB SERVER

PHP's built-in web server did not start supporting the PATCH HTTP method until 5.4.8. Since the admin API makes use of this HTTP method, you must use a version >= 5.4.8 when using the built-in web server.

NOTE ABOUT USING APACHE

Apache forbids the character sequences %2F and %5C in URI paths. However, the Apigility Admin API uses these characters for a number of service endpoints. As such, if you wish to use the Admin UI and/or Admin API with Apache, you will need to configure your Apache vhost/project to allow encoded slashes:

AllowEncodedSlashes On

This change will need to be made in your server's vhost file (it cannot be added to .htaccess).

NOTE ABOUT OPCACHE

Disable all opcode caches when running the admin!

The admin cannot and will not run correctly when an opcode cache, such as APC or OpCache, is enabled. Apigility does not use a database to store configuration; instead, it uses PHP configuration files. Opcode caches will cache these files on first load, leading to inconsistencies as you write to them, and will typically lead to a state where the admin API and code become unusable.

The admin is a development tool, and intended for use a development environment. As such, you should likely disable opcode caching, regardless.

When you are ready to deploy your API to production, however, you can disable development mode, thus disabling the admin interface, and safely run an opcode cache again. Doing so is recommended for production due to the tremendous performance benefits opcode caches provide.