Download the PHP package dbout/wp-module-rest-api without Composer
On this page you can find all versions of the php package dbout/wp-module-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dbout/wp-module-rest-api
More information about dbout/wp-module-rest-api
Files in dbout/wp-module-rest-api
Package wp-module-rest-api
Short Description Quickly add routes to the WordPress Rest API.
License MIT
Homepage https://github.com/dimitriBouteille/wp-module-rest-api
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package wp-module-rest-api
WordPress Rest API
WordPress module designed for developers that want to add routes to the WordPress Rest API in a few moments.
💡 To simplify the integration of this library, we recommend using WordPress with one of the following tools: Bedrock, Themosis or Wordplate.
Documentation
If you want to know more about how the WordPress API works, you can read the WordPress documentation :)
- Installation
- Basic usage
- Error handling
- Permission
- Route loader options
Installation
Requirements
The server requirements are basically the same as for WordPress with the addition of a few ones :
- PHP >= 8.1
- Composer
Installation with composer
You can use Composer. Follow the installation instructions if you do not already have composer installed.
composer require dbout/wp-module-rest-apiIn your PHP script, make sure you include the autoloader:
require __DIR__ . '/vendor/autoload.php';Usage
Before creating your first route, you must initialize the module. It is advisable to add this code at the beginning of the functions.php file of your theme or in a mu-plugin.
💡 The module will automatically search for all classes that are in the folder and sub folder.
💡 You can pass as the second argument of RouteLoader an option object: read the documentation.
Now you have initialized the module, you just need to create your first route in the routes folder.
You just created 2 routes 🎉
GET:wp-json/app/v2/document/18DELETE:wp-json/app/v2/document/18
The logic is extremely simple, you can use the following methods: GET, POST, PUT, PATCH and DELETE
If you need, you can define multiple methods for an action by passing a method array :
Callback arguments
If your route contains parameters, you can retrieve them as an argument for your function :
💡If your function contains a
WP_REST_Requestargument, the WP_REST_Request object will be passed as an argument.
Contributing
We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements. Have a look at our contributing guidelines to find out how to raise a pull request.
