How to create a WordPress REST API plugin with CRUD operations on a custom table

Have you ever thought about how plugins like Jetpack CRM, Yoast SEO, Gravity Forms, or many other plugins can add their own endpoints to the native WordPress REST API? Well, in this tutorial, we will review how to create a plugin for the WordPress REST API with CRUD operations on a custom table. Here are some benefits of creating a WordPress plugin that adds an endpoint to the REST API and allows performing CRUD operations on a custom table:

1. Flexibility and Customization: By creating a custom plugin, you have full control over the CRUD operations on your custom table. You can define the routes, methods, and parameters according to your specific needs.
2. Integration with Other Systems: By using the WordPress REST API, you can integrate your custom table with other systems and applications. This allows you to share data easily and securely with other platforms, such as mobile applications, external content management systems, e-commerce systems, and more.
3. Task Automation: By providing a REST API endpoint for your custom table, you can automate the creation, reading, updating, and deletion of data. This can save you time and effort by eliminating the need to perform these tasks manually.
4. Access to Data from Anywhere: The REST API allows you to access your data from anywhere via HTTP requests. This means you can perform CRUD operations on your custom table from applications, web services, or even from other websites.
5. Scalability and Modularity: By using the REST API, your custom table becomes an independent resource that can be scaled and used in different contexts. You can add more endpoints and functionalities as needed, providing you with greater flexibility to adapt to future changes and requirements.
6. Performance Improvement: By using the REST API instead of accessing the database directly, you can leverage the caching and performance optimizations built into WordPress. This can result in better response times and faster load times for your CRUD operations.
7. Security and Access Control: You can apply authentication and permission controls to your REST API endpoints to ensure that only authorized users can access and manipulate the data in your custom table. This gives you greater control over the security of your data.

In summary, by creating a plugin that adds an endpoint to the WordPress REST API to manipulate data in a custom table, you gain flexibility, integration with other systems, task automation, access from anywhere, scalability, improved performance, security, and access control. These benefits can significantly enhance the functionality and efficiency of your WordPress-based website or application.

Step 1: Environment Preparation

1. Create a folder in the location wp-content/plugins of your WordPress installation. You can name it whatever you wish, for example, “rest-api-clientes”.
2. Inside the newly created folder, create a file named rest-api-clientes.php. This will be the main file of our plugin.

Step 2: Database Table Creation

1. Open the file rest-api-clientes.php in your code editor and add the following code at the beginning of the file:

<?php;

This code creates the structure of the clientes table in the database using the dbDelta(). function. The table will have four columns: id (auto-increment primary key), nombre, correo_electronico y telefono. The crear_tabla_clientes() function will be executed when the plugin is activated and will create the table.

Step 3: REST API Endpoint Registration

1. Next, we will add the code to register the REST API endpoint and define the CRUD operations. Add the following code after the previous code block:

// Function to get a client by ID;

This code defines the functions obtener_cliente(), crear_cliente(), actualizar_cliente() y eliminar_cliente(), which correspond to the read, create, update, and delete operations respectively. These functions use the instance of the wpdb class to interact with the clientes table in the database.

Then, the function registrar_endpoint_rest_clientes() is responsible for registering the REST API endpoint using register_rest_route(). The routes and methods are defined for each operation.

Step 4: REST API Testing

1. Now that we have registered the REST API endpoint, we can test it. Make sure the plugin is active in your WordPress installation.
2. To get a client by ID, you can make a GET request to the following URL in your browser: http://yoursite.com/wp-json/clientes/v1/1
   • Replace “yoursite.com” with your website's URL and “1” with the ID of the client you wish to retrieve. You should receive the client's data in JSON format.
3. To create a client, you can make a POST request to the following URL using a tool like Postman: http://yoursite.com/wp-json/clientes/v1/
   • Make sure to send the required parameters (nombre, correo_electronico y telefono) in the request body in JSON format.
4. To update a client by ID, you can make a PUT request to the following URL using a tool such as Postman: http://yoursite.com/wp-json/clientes/v1/1
   • Replace “yoursite.com” with your website URL and “1” with the ID of the client you wish to update. Ensure you send the required parameters (nombre, correo_electronico y telefono) in the request body in JSON format.
5. To delete a client by ID, you can make a DELETE request to the following URL using a tool such as Postman: http://yoursite.com/wp-json/clientes/v1/1
   • Replace “yoursite.com” with your website URL and “1” with the ID of the client you wish to delete.

Complete Code

<?php;

Conclusion

Congratulations! You now have a plugin that adds an endpoint to the WordPress REST API for performing CRUD operations on a custom table. You can customize and extend this plugin according to your needs.

Remember that it is important to exercise caution when working with the REST API and ensure you protect your endpoints appropriately, using authentication and permission controls as necessary.

I hope this tutorial has been helpful and has provided you with a clear understanding of how to create a plugin for the WordPress REST API with CRUD operations on a custom table.