Headless WordPress with the HTTP REST API 2.0+

Using WordPress as a headless system, is nothing new. You can easily build out your own REST API or use the long available HTTP REST API 1.0+ for WordPress.

But with the new HTTP REST API 2.0+ its getting really easy to build out your own REST API Namespace and assign routes for all your JSON needs.

The new REST API will make its appearance in WordPress 4.4, but you can start now by adding the plugin to your system. When the plugin detects 4.4+ it will only load functionality not already present in the core.

A ROUTE

A route tells the API to respond to a given request with a specific function (endpoint). This adds the permalink structure to WordPress so that your functionality can be accessed via an url like this: http://yourdoman.com/wp-json/yourplugin/v1/myfunction/your_parameter 

  1. add_action( 'rest_api_init', function () {
  2.     register_rest_route( 'your_namespace/v1', '/your_endpoint/(?P<your_parameter>\d+)', array(
  3.         'methods' => 'GET',
  4.         'callback' => 'your_endpoint',
  5.     ) );
  6. } );

THE ENDPOINT

The Endpoint is the callback handled by the route. Each endpoint can have additional parameters attached:

  1. custom permissions
  2. default values
  3. sanitization callback
  4. validation callback
  5. field requirements and more

RETURN VALUE

The return values from the endpoint are converted into JSON. You can use the WP_REST_Response object , this wraps normal body data and allows you to return a custom status code.

  1. function your_endpoint( $data ) {
  2.     $posts = get_posts( array(
  3.          'author' => $data['your_parameter'],
  4.     ) );
  5.  
  6.     if ( empty( $posts ) ) {
  7.         return new WP_Error( 'your_endpoint_no_data', 'No Data', array( 'status' => 404 ) );
  8.     }
  9.  
  10.     return new WP_REST_Response( $posts, 200 );
  11. }

Really powerful stuff, that makes it easy to detach WordPress and the actual client using the data provided by it.

You can read more about it here.

Enjoy coding …

Alex

I am a full-stack developer. I love programming,  design and know my way around server architecture as well.  I would never feel complete, with one of these missing. I have a broad range of interests, that’s why I constantly dive into new technologies and expand my knowledge where ever required. Technologies are evolving fast and I enjoy using the latest. Apart from that, I am a peace loving guy who tries to have people around him that think the same.  I truly believe in the principle: “If you help someone, someone will help you, when you need it."

Recent Posts

Particle Network Animations in Javascript

What are particle animations? Particle network animations in JavaScript typically involve creating visual representations of… Read More

3 days ago

B&B / Hotel Booking Solutions for WordPress | 2024

BOOKING SOLUTIONS 202x This is my take on a subset of booking, appointment, PMS or… Read More

1 month ago

WordPress Cron + WP-CLI + Ntfy

THE GOAL Create a system cron for WordPress, that is accessible and can be easily… Read More

2 months ago

2024 is here and now :)

2024, what's cooking? Slowly getting into the 2024 spirit. 3 projects coming to a close… Read More

4 months ago

2023 ends and whats next !

Short look back at 2023 This has been a busy and interesting year. I am… Read More

4 months ago

cubicFUSION Grid Tweaker – Elementor Grid made easy.

Elementor Pro provides grid containers as an experimental feature. The options provided are limited, when… Read More

5 months ago